docs: polish README nav, quickstart, and comparison table#2
Merged
Conversation
- Trim top nav from 18 links to 8 single-row primary intents - Make SDK Quickstarts TS example additive (constraints + rules) instead of repeating the 60-second snippet - Normalize comparison table "Partial" to a consistent glyph + add legend Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
UX polish pass on the README, treating it as the project's primary landing page. No content was removed from the page body; all changes improve scannability and reduce redundancy.
Changes
1. Trim top nav from 18 links to 8. Eighteen anchor links across two rows defeated the nav's purpose (Hick's Law). Cut to the distinct user intents — Quickstart, What It Does, SDKs, Protocol, Mode B, Compare, Demos, Get Involved — on a single row. The dropped sections (Integrations, Problem, Compatibility, Delegation, Ecosystem, Prior Art, Foundation, Status, License, Origin) still exist in the body, reachable by scroll.
2. De-duplicate the TypeScript quickstart. The SDK Quickstarts TS block was ~90% identical to the 60-second snippet, creating déjà vu for a scrolling reader. It now teaches something new on the same grant: a hard
constraintsvalue and a behavioralrule(enforcement: "hard"), which is APOA's actual differentiator. Grounded in the real facade API (createGrantacceptsconstraints/rules;Ruleis{ id, description, enforcement }).3. Make the comparison table scan as one visual system. The Auditable column mixed
Partial(text) with ✅/❌ (icons), stopping the eye. Normalized to🟡, added a legend (✅ full · 🟡 partial · ❌ none) and a one-line takeaway caption. The caption also helps accessibility, since the table's meaning no longer rests solely on emoji that screen readers announce inconsistently.Notes
Docs-only change, no build step required. The new TS snippet mirrors the runnable example in
examples/quickstart-typescript.🤖 Generated with Claude Code