Graphora Documentation

This repository contains the documentation for the Graphora platform and client library. The documentation is built using Mintlify, a modern documentation platform.

Structure

The documentation is organized into the following sections:

• Platform: Overview and quickstart guide for the Graphora platform
• Client Library: Documentation for the Graphora Python client library
  • Getting Started: Introduction, installation, and quickstart guides
  • Core Concepts: Detailed explanations of key concepts like ontologies, transformations, merging, and graphs
  • API Reference: Detailed reference for the client library classes and methods
  • Examples: Sample code demonstrating common use cases
• API Reference: Documentation for the Graphora REST API

Development

To work on the documentation locally, follow these steps:

1. Install the Mintlify CLI:

npm i -g mintlify

2. Clone this repository:

git clone https://github.com/graphora/docs-graphora.git
cd docs-graphora

3. Start the development server:

mintlify dev

4. Open your browser and navigate to http://localhost:3000 to see the documentation.

Contributing

We welcome contributions to improve the documentation! Here's how you can contribute:

1. Fork the repository
2. Create a new branch for your changes
3. Make your changes
4. Submit a pull request

Please ensure your changes are well-written, accurate, and follow our documentation style guide.

Deployment

Changes to the main branch are automatically deployed to the production documentation site at docs.graphora.io.

Contact

If you have any questions or feedback about the documentation, please contact us at support@graphora.io.