docs(architecture): reframe architecture-overview as backend-first (worked example) [DRAFT] - #5450
Draft
bgrenon wants to merge 1 commit into
Draft
docs(architecture): reframe architecture-overview as backend-first (worked example) [DRAFT]#5450bgrenon wants to merge 1 commit into
bgrenon wants to merge 1 commit into
Conversation
Rewrite content/docs/introduction/architecture-overview.md so the storage/compute separation story is framed as the foundation of the whole Neon backend (Postgres, Object Storage, Functions, Managed Better Auth), not just the database. Adds a new section explaining how each backend service attaches to and forks with a branch, notes that Object Storage/Functions branching is flag-gated, that Auth rides along because its state lives in Postgres, and that the AI Gateway does not branch (account-scoped credentials). Preserves all existing technical detail on compute/storage internals, write/read paths, and durability. Co-authored-by: omnigent <noreply@omnigent.ai>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Proof of concept: backend-first docs reframe
For two years, Neon docs have framed the product as "serverless Postgres" with features orbiting the database. The proposed reframe: Neon is a full-service application backend, of which serverless Postgres is the foundation.
This PR reworks a single page,
content/docs/introduction/architecture-overview.md, as a worked example to see whether that reframe holds up in a real diff before applying it more broadly. This page was picked because it's the deepest and most database-only page in the docs: it explained the whole architecture purely as Postgres storage/compute separation and never brought Auth, Object Storage, Functions, or the AI Gateway into the mental model.What changed
Accuracy constraints honored
These were given as hard, pre-verified constraints for this rewrite. A reviewer should check each:
Admonitioncallout rather than scattering hedges through the page.neon_authschema), not because it's a separate branch-aware system. The page frames it exactly this way: "doesn't add a separate branch-aware system at all... branches for free whenever Postgres does."Note on an existing inconsistency (not touched here, out of scope)
While reading
introduction/branching.mdandai-gateway/overview.mdfor voice/consistency, I found both currently say the AI Gateway does branch (branching.md: "Object Storage, Functions, and AI Gateway all branch with your data too... isolated gateway endpoint"; ai-gateway/overview.md summary: "Each branch gets its own gateway endpoint."). That contradicts the verified constraint given for this task. I did not change those pages since they're out of scope for this PR, but they likely need a correction pass if the AI Gateway's account-scoping is confirmed correct.Checks run
npx prettier --checkon the touched file: cleannpx markdownlint --ignore-path .gitignoreon the touched file: cleannpx vitest run scripts/docs-checks/**/__tests__/*.test.js(docs-specific checks): 47/47 passednpm run test:unit:run(full unit suite, same as the pre-push hook): 677/677 passed/docs/storage/overview,/docs/compute/functions/overview,/docs/auth/overview,/docs/ai-gateway/overview,/docs/get-started/backend-overview, etc.) resolves to a real file#storage-layer,#what-this-architecture-enables) are unchanged so existing external links don't breakThis pull request and its description were written by Isaac.