[DOC] polish package search docs #5447
Conversation
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
|
Chroma Documentation: Major Overhaul, Structural & Copy Improvements, Markdoc Metadata Unification This pull request is a sweeping, large-scale update to the Chroma documentation site and its underlying Markdoc structure. The changes unify and standardize frontmatter metadata (adding Key Changes• Standardized frontmatter in all Markdoc Markdown files: adds Affected Areas• Documentation site content: This summary was automatically generated by @propel-code-bot |
![propel-code-bot[bot]](https://avatars.githubusercontent.com/in/1179004?s=60&v=4){kind=small}
| {% /Step %} | ||
|
|
||
| {% Step %} | ||
| In the Setting's menu, click on the {% ImageHoverText src="code-collections-api-keys.png" %}API Keys tab{% /ImageHoverText %}, and then on the {% ImageHoverText src="code-collections-api-keys.png" %}Create button{% /ImageHoverText %} to generate a key. Copy your API key, as you will need it to connect to the MCP server. | ||
| In the Settings menu, click on the {% ImageHoverText src="package-search-api-keys.png" %}API Keys tab{% /ImageHoverText %}, and then on the {% ImageHoverText src="package-search-api-keys.png" %}Create button{% /ImageHoverText %} to generate a key. Copy your API key, as you will need it to connect to the MCP server. | ||
| {% /Step %} | ||
|
|
||
| {% ComboboxEntry value="claude-code" label="Claude Code" %} |
There was a problem hiding this comment.
[Documentation]
Fix grammar: "Setting's" should be "Settings"
Context for Agents
[**Documentation**]
Fix grammar: "Setting's" should be "Settings"
File: docs/docs.trychroma.com/markdoc/content/cloud/package-search/mcp.md
Line: 42| - `local` - Instructs the CLI to find your collection on a local Chroma server at `http://localhost:8000`. If your local Chroma server is available on a different hostname, use the `host` argument instead. | ||
| - `host` - The host of your local Chroma server. This argument conflicts with `path`. | ||
| - `path` - The path of your local Chroma data. If provided, the CLI will use the data path to start a local Chroma server at an available port for browsing. This argument conflicts wth `host`. | ||
| - `theme` - The theme of your terminal (`light` or `dark`). Optimizes the UI colors for your terminal's theme. You only need to provide this argument once, and the CLI will persist it in `~/.chroma/config.json`. | ||
|
|
||
| {% TabbedUseCaseCodeBlock language="Terminal" %} |
There was a problem hiding this comment.
[Documentation]
Fix spelling error: "wth" should be "with"
Context for Agents
[**Documentation**]
Fix spelling error: "wth" should be "with"
File: docs/docs.trychroma.com/markdoc/content/docs/cli/browse.md
Line: 23| - `to-local` - Sets the copy target to a local Chroma server. By default, the CLI will try to find it at `localhost:8000`. If you have a different setup, use `path` or `host`. | ||
| - `to-cloud` - Sets the copy target to a DB on Chroma Cloud. | ||
| - `db` - The name of the Chroma Cloud DB with the collections you want to copy. If not provided, the CLI will prompt you to select a DB from those available on your active [profile](./profile). | ||
| - `host` - The host of your local Chroma server. This argument conflicts with `path`. |
There was a problem hiding this comment.
[Documentation]
Fix spelling error: "wth" should be "with"
Context for Agents
[**Documentation**]
Fix spelling error: "wth" should be "with"
File: docs/docs.trychroma.com/markdoc/content/docs/cli/copy.md
Line: 23
No description provided.