refactor: PostgreSQL integration documentation.#747
refactor: PostgreSQL integration documentation.#747IEvangelist wants to merge 3 commits intomainfrom
Conversation
Co-authored-by: Copilot <copilot@github.com>
There was a problem hiding this comment.
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.
alistairmatthews
left a comment
alistairmatthews
left a comment
There was a problem hiding this comment.
Just a couple of small issues.
…p host language synchronization Co-authored-by: Copilot <copilot@github.com>
IEvangelist
dismissed
alistairmatthews’s stale review
Please re-review. Also, no need to use the requested changes. It just slows us down. We need to move faster.
alistairmatthews
left a comment
alistairmatthews
left a comment
There was a problem hiding this comment.
Just two comments. Really like the new Getting Started structure now.
|
|
||
| #### Read environment variables in C\# | ||
|
|
||
| If you prefer to read environment variables directly without the client integration: |
There was a problem hiding this comment.
Do we have any specific use cases for this? Why would devs prefer this approach?
| @@ -1,2 +1,2 @@ | |||
| --- | |||
| title: PostgreSQL Hosting integration | |||
There was a problem hiding this comment.
Just wondering if we should make this an action title like the other two:
- Get started
- Set up PostgreSQL in the AppHost
- Connect to PostgreSQL
... or something like that? If you agree it should be propagated to the left navigation title as well.
You could also say "Use community extensions" instead of "Community Extensions" if you wanted to make all four titles parallel.
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:
postgres-connect.mdx — expanded and merged with postgres-client.mdx:
postgres-host.mdx — reframed as the AppHost API reference:
postgres-client.mdx — deleted (content merged into Connect).
Navigation and routing
edirects.mjs: /integrations/databases/postgres/postgres-client/ → /integrations/databases/postgres/postgres-connect/.
Screenshots
Sidebar
Get started