Skip to content

[DOC] Add cloud docs, architecture docs, data model doc #4859

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: main
Choose a base branch
from

Conversation

HammadB
Copy link
Collaborator

@HammadB HammadB commented Jun 17, 2025

Description of changes

Adds docs for

  • chroma architecture across various topologies

  • chroma data model

  • chroma cloud overview

  • chroma cloud pricing

  • chroma cloud quotas and limits

  • TODO: images

Test plan

How are these changes tested?
These are docs, manually checking for:

  • Broken links
  • Images
  • Copy

Documentation Changes

These are docs :)

Copy link
Contributor

propel-code-bot bot commented Jun 17, 2025

Add Cloud, Architecture, and Data Model Documentation for Chroma

This PR introduces a comprehensive set of documentation for Chroma, including new pages detailing the system architecture, data model, Chroma Cloud overview, pricing, quotas, and usage limits. The updates significantly enhance both the depth and navigability of the documentation by adding new content, images, and restructuring sidebar navigation to reflect these additions. Several user and internal review comments were addressed, focusing on clarity, completeness, and eliminating placeholders. The sidebar configuration for documentation navigation has also been updated to include the new documents and reflect the structure of Chroma Cloud resources.

Key Changes:
• Adds a detailed Architecture document covering components, deployment modes, request paths, and trade-offs.
• Introduces a Data Model document outlining tenants, databases, and collections, as well as data isolation principles.
• Creates dedicated documentation for Chroma Cloud, including Getting Started, Pricing, and Quotas & Limits pages.
• Updates the documentation sidebar (sidebar-config.ts) to surface the new architecture, data model, cloud, pricing, and quotas/limits pages in navigation.
• Enhances Chroma Cloud Getting Started page to provide detailed overview, reliability, security, and dashboard info.
• Addresses previously noted documentation issues such as grammar, placeholders, and link completeness.
• Incorporates images and provides manual QA instructions for broken links and images.

Affected Areas:
• Documentation content (Architecture, Data Model, Cloud, Pricing, Quotas/Limits)
• Documentation navigation/sidebar (sidebar-config.ts)
• Images and visual diagrams for docs

This summary was automatically generated by @propel-code-bot

Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readability, Modularity, Intuitiveness)

Copy link

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

@HammadB HammadB changed the title [DOCS] Add cloud docs, architecture docs, data model doc [DOC] Add cloud docs, architecture docs, data model doc Jun 17, 2025
@HammadB HammadB requested review from itaismith and jeffchuber June 17, 2025 17:15
@HammadB
Copy link
Collaborator Author

HammadB commented Jun 17, 2025

Remaining TODO:

  • Upload images
  • Final personal copy pass
  • Final broken link pass

Copy link

Please tag your PR title with one of: [ENH | BUG | DOC | TST | BLD | PERF | TYP | CLN | CHORE]. See https://docs.trychroma.com/contributing#contributing-code-and-ideas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants