docs: audience-first restructure, de-slop, and visual pass - #2
Merged
Merged
Conversation
… page
Truth fixes on all 22 hand-written pages, checked against the product
code and live endpoints on 2026-08-26. Highlights:
- Chat app: encryption is a toggle (Maximum Privacy Mode), off by default.
Attachments and knowledge-base documents are not encrypted at rest.
Persistent history is encrypted with a Solrouter-held key.
Image and video generation is disabled (Archived).
- Models: gpt-oss:20b and qwen3.8:27b (Live), gemma4:31b (Soon),
qwen3:8b retired. One id format.
- Nosana GPU node sees the prompt during inference; stated on every
page that described the request path.
- Agent: useTools runs a tool loop (up to 8 model calls); the guided
path is reasoning: 'braid'. Benchmark numbers without a source
removed. Skill graph has 44 nodes; the response carries no skillGraph.
- @solrouter/agent-tools is not on npm: install steps removed, Soon.
- Attestation: both report_data formulas; receipts are Light Protocol
compressed accounts, not PDAs; umbra_attestation is a swap artifact.
- Managed wallets: KEK lives in the backend process, not the enclave.
- MCP: 22 tools; four use the encrypted path for the model step; search
and market lookups leave the machine in plaintext.
- x402: the manifest is on api.solrouter.com and advertises Coinbase.
- Removed both duplicated ASCII request-flow blocks and all em dashes.
Every page now declares status (live | soon | archived | mixed) and
checked: 2026-08-26 in frontmatter. The status sentence renders under
the title and is prepended in llms-full.txt and the .md routes.
EncryptionFlow gains the Nosana stage, a return arrow, role=img, and an
encrypted={false} variant.
- sitemap.xml and robots.txt from the page tree; lastmod from checked. - metadataBase so OG image URLs are absolute. - llms-full.txt puts Introduction first and generated API pages last. - next.config.mjs redirects hook with a moves list (empty until pages move). - scripts/check-docs.mjs (npm run check): fails on em or en dashes, banned words, missing status or checked frontmatter, and diagrams without an In words list. - GitHub Actions workflow: npm ci, types:check, check, build. - README replaces the Create Fumadocs boilerplate with the status policy, the truth rule, the diagram rule, and the PR checklist. - package-lock.json re-synced with package.json (npm ci failed on @emnapi/wasi-threads). Adds @xyflow/react 12.11.5 for the interactive diagrams that land next. - .scratch/ ignored (local wayfinder tracker).
…wed drafts) New pages: what-is-a-tee, what-is-private, verify-a-reply, use-cases, glossary, under-the-hood (architecture map), under-the-hood/request-flow, under-the-hood/agent-reasoning. Introduction gains the before/after diagram and Start-here cards. Sidebar lists the new pages. New components: sealed-room, plaintext-zones, typical-vs-solrouter (static SVG), key-quote-inspector (live check of /tee/public-key against /tee/attestation in the browser), and the React Flow scaffolding (flow-canvas, box-node, flow-figure, data for the system map, the ten-step request flow, and the 44-node skill graph copied from skillGraphEngine.js). React Flow token overrides appended to global.css. Status: drafts. Truth-checked by their authors against code, type-check and build pass, not yet reviewed by a second pass and not yet checked in a browser. Do not merge before that review.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Sarthib7
changed the title
Collaborator
Author
|
@vercel review |
Adds the @emnapi wasm32-wasi entries (incl. @emnapi/runtime@1.11.3) npm ci needs on Linux; transitives refreshed within semver. next/fumadocs/@xyflow unchanged.
Sarthib7
marked this pull request as ready for review
August 27, 2026 11:57
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.
What this delivers
A redesign of docs.solrouter.com. The docs now follow an audience-first structure, with Diátaxis inside each section:
Key changes
Truth. Every hand-written page was checked against the product code and the live API on 2026-08-26; 46 wrong or stale claims were corrected.
statusandcheckedstay in frontmatter.Structure. Pages moved into
use/,build/,how-it-works/, andapi-reference/, with redirects for every old slug and its.mdtwin. Duplicate content was merged: the four agent pages into one, the two authentication pages into one, and the redundant "how it works" prose page removed.De-slop. The overstuffed landing became a short router. The seven-column "who can see what" table with 36 footnotes became a color-coded matrix with six notes. Internal
be:file:linecitations were stripped from every reader-facing page. The per-page status line now shows only when a page is not fully Live.Visuals. A React Flow architecture map, a request-flow stepper, and a 44-node skill graph; a React Flow "Typical AI API" before-and-after on the landing; a
PrivacyMatrixcomponent; card typography and spacing fixes; and the encryption-proof and key-and-quote verifier widgets on the Verify page.Verification
npm run check: 26 pages ok (no em or en dashes, no banned words,statuson every page, an "In words" list or table after every diagram).be:/Source:citations across all ofcontent/docs, including the generated API pages.meta.json, and the matrix port, and found no broken link, orphaned page, or render error.next build. The dev server compiles every route; runnext buildin CI before merge.Before merge
next buildin CI.gpt-oss:20bfor raw HTTP versusgpt-oss-20bfor the SDK is context-dependent, so confirm each callsite.@solrouter/agent-toolson npm,gemma4:31b, tokenomics figures, swap status, and retention periods.Backend follow-ups found while writing (not changed here)
paid.amount: 0.02while the paywall charges 0.005.http://.gpt-oss:20b.qwen3-8bto the retirednosana:qwen3:8b; the defaultbaseUrlis the Render host.mcpHttp: /mcp/v1with no such route mounted.