Skip to content

Describe the packages as Chroma integrations, and complete the package READMEs - #3

Merged
Laurianti merged 7 commits into
mainfrom
docs-settings-and-descriptions
Oct 5, 2026
Merged

Laurianti merged 7 commits into
mainfrom
docs-settings-and-descriptions

Conversation

@Laurianti

Copy link
Copy Markdown
Member
  • Package descriptions: they say Chroma, not ChromaDB. ChromaDotNet.Aspire.Hosting: "Aspire hosting integration for Chroma: a Chroma container in the AppHost.", ChromaDotNet.Aspire.Client: "Aspire client integration for Chroma and Chroma Cloud: a ChromaClient of ChromaDotNet.Client with health checks, traces and metrics.", both followed by "Built from the Chroma integration proposed to the Community Toolkit for Aspire, until it ships there. Community project, not affiliated with the .NET Foundation or Chroma." The tags and the icon are unchanged.
  • Community project: the package READMEs and the README say that the project is a community project, not affiliated with the .NET Foundation, the Community Toolkit or Chroma.
  • Client package README: the example has its using ChromaDB.Client;. The text names the Endpoint setting, says that HealthCheckTimeout is in milliseconds, which values win (connection string over settings, configureSettings over both), the health check names (Chroma, Chroma_{name} for a keyed client) and builder.AddConnectionString("chroma") in the AppHost.
  • Hosting package README: the port of AddChroma, the connection string and the connection properties Host, Port and Uri, and the methods exported to TypeScript AppHosts, with a link to the example.
  • README: where the package READMEs are, which files are synced from Add Chroma hosting and client integrations CommunityToolkit/Aspire#2219 and which belong to this repository, and how to build and test.

The folders synced from CommunityToolkit/Aspire#2219 are unchanged.

Copilot AI balanced review requested due to automatic review settings October 5, 2026 11:52

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot review overview

🟡 Changes recommended

The completed READMEs are not wired into package creation, and both omit a stated affiliation disclaimer.

Review effort: Balanced
Findings: 1 Medium severity · 2 Low severity

Open (3)
What changed in this PR

Updates package descriptions and expands project/package documentation for the Chroma Aspire integrations.

Changes:

  • Refines NuGet package descriptions.
  • Documents configuration, hosting APIs, build, and test workflows.
  • Adds community-project disclaimers.
File Description
src/​Directory.Build.targets Updates package descriptions.
README.md Expands repository and build guidance.
docs/​packages/​CommunityToolkit.Aspire.Hosting.Chroma.md Documents hosting APIs.
docs/​packages/​CommunityToolkit.Aspire.Chroma.md Documents client configuration.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md
Comment thread docs/packages/CommunityToolkit.Aspire.Chroma.md Outdated
Comment thread docs/packages/CommunityToolkit.Aspire.Hosting.Chroma.md Outdated
@Laurianti
Laurianti merged commit 8e27db3 into main Oct 5, 2026
3 checks passed
@Laurianti
Laurianti deleted the docs-settings-and-descriptions branch October 5, 2026 12:05
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