Skip to content

docs(storage): bring docs up to parity with last 30 days of code + IA audit#5208

Merged
bgrenon merged 4 commits into
mainfrom
polly/storage
Jul 11, 2026
Merged

docs(storage): bring docs up to parity with last 30 days of code + IA audit#5208
bgrenon merged 4 commits into
mainfrom
polly/storage

Conversation

@bgrenon

@bgrenon bgrenon commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator

Summary

Brings Storage docs up to parity with the last 30 days of hadron/neon-cloud changes, plus fixes from a persona-driven IA read-through.

Changes

  • storage/get-started.md
    • Reordered prerequisites: {project_id}/{branch_id} lookup now comes before the first manual API call
    • Promoted bucket creation to its own explicit step; moved endpoint lookup before credentials
    • Added a branch-readiness note and 404 troubleshooting guidance
  • introduction/architecture-overview.md
    • Corrected a commit-latency/fsync behavior claim (DOC-26588)

Verified, not changed

  • neon.neon_backpressure_status() exists in the extension but is intentionally left undocumented (that reference page is scoped to LFC, not exhaustive)
  • "Up to 5 protected branches" is still accurate today; flagging a forward-looking watch item — hadron PR #7196 hard-codes "one protected timeline per tenant" behind an opt-out flag with no production callers yet

Co-authored-by: omnigent <noreply@omnigent.ai>
@bgrenon
bgrenon requested a review from danieltprice as a code owner July 7, 2026 19:57
@vercel

vercel Bot commented Jul 7, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
neon-next Building Building Preview, Comment Jul 9, 2026 11:22pm

Request Review

@bgrenon

bgrenon commented Jul 8, 2026

Copy link
Copy Markdown
Collaborator Author

IA-audit follow-up applied in 83283228c.\n\nFixed local Storage quickstart findings:\n- Added the missing @neon/config install, neon link, and branch confirmation steps before neon deploy.\n- Added branch creation/readiness guidance for the manual API path, including async initialization caveat.\n- Reordered manual setup to check branch Storage endpoint readiness before credential creation.\n- Clarified Storage 404 remediation: no separate manual enable step; use neon.ts or confirm private preview access and AWS us-east-2 region.\n- Promoted bucket creation to its own ordered quickstart step before upload.\n- Re-checked the Python upload snippet; the duplicate print('Uploaded!') is not present in the current file.\n- Did a quick local pass over objects.md and buckets.md; no additional small, self-contained ordering/copy-paste fixes were needed.\n\nValidation:\n- npx markdownlint --ignore-path .gitignore content/docs/storage/get-started.md content/docs/storage/objects.md content/docs/storage/buckets.md ✅\n- npm run check:docs ✅\n- Commit hook also ran npm run test:unit:run ✅\n\nNote: npm run lint:md -- content/docs/storage/get-started.md content/docs/storage/objects.md content/docs/storage/buckets.md still expands to repo-wide markdownlint and fails on unrelated pre-existing files under public/; targeted Storage markdownlint passes.

…ift)

LKB-14723: architecture-overview.md no longer has an #archive-storage
anchor after an earlier rewrite. glossary.md has an equivalent
"Archive storage" definition, so point both links at it instead.

@danieltprice danieltprice left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

lgtm!

@bgrenon
bgrenon merged commit f8ff0a3 into main Jul 11, 2026
2 checks passed
@bgrenon
bgrenon deleted the polly/storage branch July 11, 2026 12:57
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