Docs revamp: auths-mcp leads, on the ledger, with guardrails#3
Merged
Conversation
…av, the ledger The four architectural debts are paid: content renders through Markdoc.renderers.react with a real tag schema (callout, cards, steps, synced code-tabs, verdict chips — zero dangerouslySetInnerHTML for content); every page is served by one [...slug] catch-all with metadata from frontmatter; the nav derives from a validated frontmatter contract (product/section/order/lastReviewed) so it cannot drift from disk; and the URL-keyed CodeExamples rail, the hand-written page files, and the hand-maintained nav array are gone. Design language is the marketing ledger tuned for reading — paper/ink/ seal tokens with a dark variant, terminal-framed code panes with copy buttons and verdict-colored transcript lines, Lucide icons (no emoji), system typeface kept. Identity content is demoted under its own product switch; the illustrative-only mcp-setup page is deleted ahead of the real auths-mcp docs. Auths-Id: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Device: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Anchor-Seq: 1
Ten auths-mcp pages take a reader from 'what is this' to a refusal they caused themselves to real money behind a cap — every command reconciled against the gateway's clap surface (the --rail/paid.call question is resolved from source: the seatbelt keys off the paid.call scope), every verdict string exact, danger callouts and --test-mode-first tabs on every page that can touch a live rail. The demoted identity docs are scrubbed to the same copy rules and their dead links fixed. Guardrails wired as CI: copy lint, verdict lint against the source-derived string set, internal + external link check (it already caught a dead repo link), and the frontmatter contract — plus build-time Markdoc validation. bun run check runs the lot. Auths-Id: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Device: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Anchor-Seq: 1
--show-mode transcripts render as output fences (the $-prefixed line is the command, the disclosure is what it prints); every bash fence is pure runnable lines, with the wallet/key guidance moved into the prose above it — what you copy is exactly what you run. Auths-Id: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Device: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Anchor-Seq: 1
prism-react-renderer bundles no bash grammar, so every bash fence on the site tokenized as one plain blob and the theme's comment color was dead code. Register the grammar once (prismjs, via the library's documented extension point), push comments firmly into the background (dim italic vs bright commands), stop defaulting bare fences to bash (ASCII diagrams are text), alias sh/shell/zsh/console onto bash, and make transcript copy lift only the runnable $ lines, prompt stripped — copy always equals what you run. Auths-Id: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Device: did:keri:EB5cPHY0t-ejNC_rUzPS1dclTvd6kG-R9mQzjozCuGgd Auths-Anchor-Seq: 1
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.
Rebuilds the docs on the plan in
auths-docs/docs/prompts/build.md, with the owner's design direction: the marketing site's ledger palette (paper/ink/seal, light + dark), current typeface kept.Architecture (the four debts, paid)
Markdoc.renderers.reactwith a real tag schema (callout, card/card-group, steps, synced code-tabs, verdict chips); zerodangerouslySetInnerHTMLfor content; unknown tags fail the build.app/docs/[...slug]catch-all; per-page React files deleted; metadata from frontmatter.CodeExamples.tsx(URL-keyed right rail) retired; code lives inline, with synchronized language tabs (localStorage +?lang=deep link + ARIA tablist + graceful fallback).product/section/order/lastReviewed); auths-mcp leads, Identity & signing demoted behind a product switch.Content
Ten auths-mcp pages (get started ×3, core ideas ×4, spend real money ×3), every command reconciled against the gateway's clap surface and the repo's proven walkthroughs; verdict strings exact; every page that can touch a live rail opens with a danger callout and shows
--test-modefirst. Identity docs scrubbed to the house copy rules; dead links (mcp-setup, agent-demo) fixed.Guardrails (CI)
bun run check: copy lint, verdict lint (source-derived string set), internal + external link check, frontmatter contract — plus build-time Markdoc validation and type-check in.github/workflows/ci.yml. The link check already caught a dead repo link before this PR did.Verified:
bun run build+type-check+bun run checkall green (22 pages); every key page loaded and screenshotted in light and dark; tab sync verified in a real browser.🤖 Generated with Claude Code