Skip to content

docs: avoid framing pg-sprite as Aurora-specific - #35

Merged
Kiran01bm merged 1 commit into
mainfrom
kiran01bm/docs-postgres-first-sweep
Aug 15, 2026
Merged

docs: avoid framing pg-sprite as Aurora-specific#35
Kiran01bm merged 1 commit into
mainfrom
kiran01bm/docs-postgres-first-sweep

Conversation

@Kiran01bm

Copy link
Copy Markdown
Collaborator

Summary

Docs sweep to stop framing pg-sprite as an Aurora-specific tool — it is a PostgreSQL online schema-change engine that is Aurora-aware, not Aurora-only.

Why

The doc set repeatedly branded the whole engine as "for Aurora PostgreSQL" (titles, problem statements, diagrams, the one-line pitch), while the README positions it for PostgreSQL generally — community, RDS, and Aurora. That framing undersells the tool for OSS users and contradicts the stated "Be Aurora-aware, not Aurora-only" design principle.

What

  • Generalize titles, problem statements, diagram labels, and table headers from "Aurora PostgreSQL" to "PostgreSQL"; reword the pitch from "tuned for Aurora" to "Aurora-aware, not Aurora-only".
  • Update the two renamed low-level-design heading anchors everywhere they are referenced.
  • Add the missing "Self-managed / community PostgreSQL" row to the deployment-topology matrix (the README already claimed it; the matrix omitted it).
  • Keep all genuinely Aurora/RDS-specific content unchanged: failover slot loss, rds_replication / rds.logical_replication, the version-support calendar, testing tiers, and the "Aurora PostgreSQL specifics" section.
Before                                     After
┌────────────────────────────────┐         ┌────────────────────────────────┐
│ "engine for Aurora PostgreSQL" │         │ "engine for PostgreSQL"        │
│ "a large, busy Aurora          │         │ "a large, busy PostgreSQL      │
│  PostgreSQL table"             │  ────▶  │  table"                        │
│ pitch: "tuned for Aurora"      │         │ pitch: "Aurora-aware,          │
│ topology matrix: Aurora + RDS  │         │  not Aurora-only"              │
│  rows only                     │         │ topology matrix: + self-managed│
└────────────────────────────────┘         │  community PostgreSQL row      │
                                           └────────────────────────────────┘
Aurora-specific technical content (slot loss on failover, rds_replication,
version calendar, testing tiers) is unchanged in both.

The engine targets PostgreSQL (community, RDS, and Aurora); titles,
problem statements, and diagrams shouldn't brand it Aurora-only.
Genuinely Aurora/RDS-specific content (failover slot loss,
rds_replication, version calendar, testing tiers) is unchanged, and
the coverage matrix gains a self-managed PostgreSQL row.
@Kiran01bm
Kiran01bm marked this pull request as ready for review August 15, 2026 04:48
@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@Kiran01bm Kiran01bm changed the title docs: stop framing pg-sprite as Aurora-specific docs: avoid framing pg-sprite as Aurora-specific Aug 15, 2026
@Kiran01bm
Kiran01bm merged commit 19b7006 into main Aug 15, 2026
7 checks passed
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