Docs redesign — week 2 chooser drafts + audit prefill#629
Closed
kiryl-xyz wants to merge 1 commit into
Closed
Conversation
Drafts the three decision-matrix landing pages from PRD §WS-3, fills in 75% of the audit Diátaxis/action columns mechanically, and annotates the 37 orphan pages with proposed dispositions. Authored (chooser pages, not yet in nav) - streaming/overview.mdx — replaces /data-streaming. Matrix-first per PRD: CardGroup of "Choose X" + 7-row "If you need…" table covering Shred Delivery, LaserStream gRPC, LaserStream Preprocessed, Yellowstone migration, Enhanced WSS, Standard WSS, and Webhooks. Followed by a decision tree and pricing-model summary. - sending-transactions/chooser.mdx — destined to fold into sending-transactions/overview.mdx at week 4. Compares Sender, Jito Bundles, sendTransaction (staked + unstaked), and the Priority Fee API. Calls out backrun rebates as additive. - chain-state/overview.mdx — replaces /getting-data. Compares Standard RPC, indexed reads, DAS, Enhanced Transactions, Wallet API, and ZK Compression. Includes a "Don't confuse these" section. These render cleanly under `mint validate` (the 13 pre-existing warnings in that command are unrelated zh/ OpenAPI schema + 2 missing-file issues; not from this PR). audit.csv prefill - 280/371 pages (75%) now have a default `diataxis_type`. - 284/371 (77%) have a default `action`. - All `api-reference/*`, `rpc/guides/*`, `faqs/*`, and openapi-backed pages → Reference + Keep. - All week-4 IA targets pre-populated with `new_url` (data-streaming → streaming/overview, grpc/* → laserstream/guides/*, enhanced-websockets/* → websockets/*, rpc/websocket/* → websockets/*, getting-data → chain-state/overview, quickstart → quickstart/nft). Orphan investigation (37 pages annotated in audit.csv `notes`) - AGENTS.mdx — keep, machine-readable index, intentionally not in nav. - api-reference/common-error-codes — wire into nav. - api-reference/laserstream/websocket/* (19 pages) — wire into nav under a new "LaserStream WebSocket" group, or fold into unified websockets/ after WS-1. - event-listening + event-listening/quickstart — merge into streaming/. - laserstream/websocket — merge into websockets/overview (Eng to confirm it's the same as Enhanced WebSockets). - rpc/http/get-accounts, rpc/http/get-transactions — delete; duplicate rpc/guides/*. - validator-reporting/* (7 pages) — keep, hidden, partner-only. Remaining 91 audit rows (mixed conceptual/landing pages) need human review — see SPIKE-NOTES.md for the list. Plan reference: ~/.claude/plans/users-kiryl-downloads-prd-plan-to-imple-cozy-badger.md Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This was referenced May 6, 2026
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
1 participant
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.
Stacked on top of #628. Week 2 of the redesign plan.
What ships
Three chooser drafts (PRD §WS-3)
Matrix-first per the PRD: CardGroup of "Choose X if…" + comparison table + decision tree. None are in nav yet — they'll land in nav at the week-4 IA cutover. Review on the preview deploy:
`mint validate` parses all three cleanly. Vale lint passes.
Audit prefill
Mechanical prefills: `api-reference/`, `rpc/guides/`, `faqs/*`, openapi-backed pages → Reference+Keep. PRD-mandated moves/merges populated with their `new_url`. The remaining 91 rows are mixed conceptual/landing pages that need human judgment — see SPIKE-NOTES.md for the list.
Orphan investigation
Detailed in SPIKE-NOTES.md and `audit.csv` `notes` column. Highlights:
Notes for review
🤖 Generated with Claude Code