Rewrite cognee documentation and apply theme

[Vasilije1990]

Summary by CodeRabbit

• New Features

  • Expanded documentation for the Cognee API, including a detailed list of new endpoints for dataset management.
  • Introduction of a new documentation file for configuring vector and graph stores.
  • Comprehensive guide on the data ingestion process, including support for multiple data sources.
  • Enhanced search module allowing robust querying within graph structures.
  • New templates for managing data enrichment and processing tasks.

• Documentation

  • Restructured and clarified existing documentation to improve usability and accessibility for new users.
  • Updated quickstart guide with clearer setup instructions.

• Chores

  • Improved theme configuration and navigation structure in the documentation for better user experience.
  • Added custom styles for a dark color scheme in the documentation interface.

[coderabbitai[bot]]

Walkthrough

The recent updates to the Cognee documentation significantly enhance clarity and usability. Key sections have been reorganized and expanded to cover new API functionalities, configuration processes, and data ingestion methods. The structure now allows users to seamlessly navigate through essential topics, improving the onboarding experience for developers. Additionally, a focus on practical examples and user permissions elevates the overall robustness of the API, facilitating easier interaction with the Cognee framework.

Changes

Files	Change Summary
docs/api_reference.md, docs/search.md, docs/templates.md	Major enhancements to API documentation, including new endpoints for data management and search functionality. Clear descriptions and examples were added for usability.
docs/configuration.md, docs/data_ingestion.md, docs/quickstart.md	Introduction of comprehensive documentation for configuration settings, data ingestion processes, and setup instructions, with practical examples provided.
docs/index.md, mkdocs.yml	Restructuring of the documentation index for clarity and improved navigation; theme and navigation updates in mkdocs.yml for better accessibility.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant Database

    User->>API: Initiate Data Ingestion
    API->>Database: Check and Prepare Data
    Database->>API: Return Status
    API-->>User: Confirm Ingestion Success

Poem

In a world of code and data bright,
A rabbit hops with pure delight.
New paths to explore, oh what fun,
With API changes, the work's just begun!
So gather 'round, developers grand,
For Cognee's magic is close at hand! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.