Skip to content

refactor: PostgreSQL integration documentation.#747

Draft
IEvangelist wants to merge 1 commit intomainfrom
dapine/postgres-ux-refactor
Draft

refactor: PostgreSQL integration documentation.#747
IEvangelist wants to merge 1 commit intomainfrom
dapine/postgres-ux-refactor

Conversation

@IEvangelist
Copy link
Copy Markdown
Member

@IEvangelist IEvangelist commented Apr 22, 2026

Refactors the PostgreSQL integration documentation to give readers a clearer "why" and a clean path from modeling the resource in the AppHost to connecting from consuming apps in any language. The PostgreSQL client article is merged into the Connect page so there is a single destination for consuming-app guidance.

Preview

What changed

Content restructure

  • postgres-get-started.mdx — rewritten as a concise orientation page:

    • New Why use PostgreSQL with Aspire section answering the missing "why".
    • New How the pieces fit together conceptual mermaid diagram showing the AppHost-owned PostgreSQL server and database flowing into a generic consuming app.
    • Two conceptual steps (no language-specific APIs) that link out to the hosting and connect references.
    • Removed duplicated install / modeling / per-language connect snippets.
  • postgres-connect.mdx — expanded and merged with postgres-client.mdx:

    • Single source of truth for consuming-app guidance.
    • Language tabs ordered alphanumerically: C# → Go → Python → TypeScript.
    • C# tab absorbs the full former client-integration content: Aspire.Npgsql install, AddNpgsqlDataSource, keyed data sources, ConnectionStrings + Aspire:Npgsql configuration, inline delegates, client health checks, and logging/tracing/metrics.
    • Prose prefers "C#" over ".NET".
    • No AppHost modeling examples on this page.
  • postgres-host.mdx — reframed as the AppHost API reference:

    • Intro now positions the page as the AppHost reference.
    • Pass custom environment variables section moved here from the connect page (it's AppHost modeling content).
    • Cross-links updated to name C#, TypeScript, Python, and Go (dropped "JavaScript"/".NET" wording).
  • postgres-client.mdx — deleted (content merged into Connect).

Navigation and routing

  • Sidebar (integrations.topics.ts) trimmed to four PostgreSQL entries:
    1. Get started
    2. Hosting integration (AppHost)
    3. Connect to PostgreSQL
    4. Community extensions
  • Redirect added in
    edirects.mjs: /integrations/databases/postgres/postgres-client/ → /integrations/databases/postgres/postgres-connect/.

Screenshots

Sidebar

image

Get started

image

Co-authored-by: Copilot <copilot@github.com>
@IEvangelist IEvangelist requested a review from eerhardt as a code owner April 22, 2026 17:55
Copilot AI review requested due to automatic review settings April 22, 2026 17:55
@IEvangelist IEvangelist marked this pull request as draft April 22, 2026 17:55
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Refactors the PostgreSQL integration docs to better separate “hosting/AppHost modeling” guidance from “consuming app connection” guidance, and streamlines the sidebar accordingly.

Changes:

  • Rewrites PostgreSQL “Get started” to a short conceptual + CTA flow instead of per-language quickstarts.
  • Expands “Connect to PostgreSQL” to include the .NET client integration content and removes the standalone client page (with a redirect).
  • Adds a small CSS tweak for Starlight <Steps> layout and updates sidebar navigation.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
src/frontend/src/styles/site.css Adjusts Steps top padding when a heading wrapper is present.
src/frontend/src/content/docs/integrations/databases/postgres/postgres-host.mdx Reframes page as hosting reference; adds LearnMore callouts; adds “Pass custom environment variables” section.
src/frontend/src/content/docs/integrations/databases/postgres/postgres-get-started.mdx Replaces long quickstart with a shorter conceptual overview + links to host/connect pages.
src/frontend/src/content/docs/integrations/databases/postgres/postgres-connect.mdx Expands into a multi-language connection guide including the C# client integration content.
src/frontend/src/content/docs/integrations/databases/postgres/postgres-client.mdx Removes the standalone client integration reference page.
src/frontend/config/sidebar/integrations.topics.ts Removes the “Client integration (.NET)” entry from the PostgreSQL sidebar group.
src/frontend/config/redirects.mjs Adds redirect from removed postgres-client page to postgres-connect.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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