Skip to content

docs: architecture dash sweep, one feature status owner, one affiliation statement - #530

Open
LeeroyHannigan wants to merge 10 commits into
feat/docs-install-pagesfrom
feat/docs-content-sweep
Open

LeeroyHannigan wants to merge 10 commits into
feat/docs-install-pagesfrom
feat/docs-content-sweep

Conversation

@LeeroyHannigan

@LeeroyHannigan LeeroyHannigan commented Oct 24, 2026 •

Copy link
Copy Markdown
Collaborator

Closes #496, closes #497, closes #498.

Third change in the documentation site series, on top of #523. It covers the three content follow-ups filed from the site review: the architecture documents' punctuation and header lines, one owner for feature status, and one affiliation statement.

What changed

Architecture documents (#496). The component designs, decision records, RFCs and the two architecture guides carried 717 em and en dashes. All of them in prose are replaced with a comma, colon, semicolon, parentheses or a sentence break; the 47 inside code fences stay. A validator compared the case-folded word sequence of every file outside code fences against the pre-change commit, so the first four commits change punctuation only. A second pass then took the sentences a prose reading found still awkward (a semicolon after a fragment, two colons on one line) and reworded them; those are in the review-fix commits. The ten design documents' Version, Date and Status header lines are in front matter, so each page opens with its heading. The product name is written ExtendDB in prose throughout the section (95 places), with inline code, paths and crate names untouched.

Feature status (#497). The usage guide's status table moves to the Differences from DynamoDB page under Feature Status, and the usage guide section is a pointer to it. Every row was checked against the engine's operation dispatch: the implemented operations are dispatched, the PartiQL and Global Tables operations fall through to UnknownOperationException, and RestoreTableToPointInTime returns ValidationException. The Requirements page's Non-Goals table and the high-level design's section 7, both written in April 2026, now carry a preface saying they record the scope as decided then and pointing at the Feature Status table; the two rows that had moved (backup and restore, policy variables in condition values) say so.

Affiliation statement (#498). One sentence stands everywhere the relationship to Amazon Web Services is stated: "ExtendDB is an open source project under the Apache License 2.0, maintained by engineers at Amazon Web Services. It is not Amazon DynamoDB and contains no DynamoDB source code." It replaces "managed by Amazon Web Services" in README.md, the site footer, the three Docker Hub overviews and the npm README, and "not affiliated with, endorsed by, or sponsored by" in docs/NOTICE.md, the 50 per-file License sections, the PDF generator (docs/build-docs.py) and the web console's Documentation page (crates/server/src/console/pages/docs_page.rs, a string literal). No tracked file carries either old wording.

Smaller items found by the review and fixed in the same change: the Requirements overview no longer claims 100 percent or byte-for-byte compatibility and no longer says three authentication modes while listing the first as removed; two internal ticket identifiers and a reference to review logs are gone from published pages; the two authentication designs (v2 and v3, published side by side) say which supersedes which; the README's nine prose dashes and its single-backend feature line are fixed.

Decisions taken

The Version, Date and Status values moved to front matter are not rendered on the site. GitHub shows them as a table at the top of each file; the site's Component designs index says the records were written as the system was built and names the Differences page as current; the auth v2 design opens with a note that v3 supersedes it. Rendering "Draft" under each heading was the alternative and was not taken.

docs/design/README.md still lists the high-availability draft because it is a directory listing of files that exist; the draft itself stays off the site.

Verification

Strict site build (broken links and anchors fail the build): 67 pages. Typecheck passes. The documentation version-literal guard test passes. cargo fmt --check passes on the one Rust file.

Three review passes against the served build, then a verify pass bound to their lists: a prose audit of every replaced punctuation mark in the diff; a content check of the Feature Status rows against crates/engine/src/lib.rs and of the affiliation statement across the tree; a site crawl of 4,509 links and 1,290 fragment targets with zero broken, the footer statement once on each of 66 pages, zero dashes in rendered prose, and an executive read of the home, architecture index, requirements, high-level design and differences pages. The Feature Status table fits a 390 px viewport without horizontal scroll (measured: client width equals scroll width).

Eleven files over 600 lines are touched; all were over 600 lines before this change and none grew by more than three lines.

Review guide

Commits are grouped by concern: the scripted dash pass; the affiliation statement, front matter and auth cache note; the feature status move; the hand dash pass; the casing pass; then three review-fix commits and one verification follow-up. The dash commits are large and mechanical; the review-fix commits are where wording changed.

@LeeroyHannigan LeeroyHannigan added the documentation Improvements or additions to documentation label Oct 24, 2026
@LeeroyHannigan

Copy link
Copy Markdown
Collaborator Author

@mdeepth

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation v1 Needed for the 1.0 release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant