microsoft / microsoft/aspire.dev

Update integration docs

Open
#30 3 comments 0 reactions 1 assignee View on GitHub

@IEvangelist is already working on this.

Since Jun 2, 2026.

Dominant language
MDX
Stars
193
Forks
87
Avg merge
1d 22h
Merged PRs (30d)
73

Description

Update the documentation for Postgres integration, serving as the template for all integrations.

Requested improvements to the integration documentation layout:

  1. Minimal Hosting Integration Code: Show only the essential code required for hosting the integration, keeping the main content concise for quick adoption.
  2. Advanced Configuration Section: Add a dedicated section for advanced configuration, organized as a nested section in the table of contents (ToC).
  3. WithReference Configuration Explanation: Clearly present what configuration is passed to other resources in WithReference.
  4. Multi-Language Pivot Example: At the bottom of the integration page, provide a pivot that shows how to consume the connection information using a client library, supporting multiple languages (please specify desired languages or libraries).

This issue starts with Postgres, but all integrations should be updated similarly. Please specify any client libraries or languages that should be prioritized.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.