docs: rebuild README, adopt agent-surface.dev, link GitHub from the docs site - #58
Merged
Merged
Conversation
README follows the orpc-agent shape: centered header, badges, doc nav, release note, mermaid authority path + invocation sequence, security model, drift-review section using real CLI output from examples/devices-app. agent-surface.dev replaces the vercel preview URL in every package homepage and README; patch changeset so the metadata ships. Docs site links back: GitHub social icon, edit link, footer source link, hero action, Project section.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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
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
Three changes, all presentation and metadata — no library code.
1. README rebuilt to match the
orpc-agentREADME's shape and quality.Centered header with tagline and badges (CI, license, Node, npm, docs), a doc-nav line, a
> [!NOTE]release/CI block, then: The idea → Why → Quick start → What happens on a call → What it gives you → Security model → Packages → Catching surface changes in review → Example → Non-goals → Development → Contributing → License.Two mermaid diagrams replace the ASCII ladder: the one authority path (untrusted above the registry, application below, compiler gating both registry and bindings), and an invocation that hits confirmation through to server re-validation.
2.
agent-surface.devis now the official docs link.Every doc link in the README points there, plus the
homepagefield in all sevenpackage.jsonfiles and theDocs:line in thewebmcp/testingREADMEs. No reference toagent-surface-docs.vercel.appremains.3. The docs site links back to GitHub.
socialLinksGitHub icon, "Edit this page on GitHub" edit link, footer source link + copyright, a "View on GitHub" hero action, and a short Project section on the home page pointing at the repo, CONTRIBUTING, and SECURITY.Why
The README was a terse spec summary;
orpc-agent's reads as a project front page. Same author, same npm scope conventions, so they should present alike. And the docs had no path back to the source.Reviewer notes
agent-surface inspectonexamples/devices-app, then temporarily flippeddevices.disabletoserver-mutation/optionalto capture a genuine drift block, and reverted the file. That produces the mirror of orpc-agent's counter-intuitive-classification point: lowering a declared effect classifies as widening, because every gate keyed to the higher effect quietly stops applying.agent-surface.devlinks return 200. The apex 308s towww, so the links work as written..changeset/docs-domain.mdbumps all seven packages at patch, per the lockstep rule in.changeset/README.md—homepageis published metadata, so it needs a release to reach npm.changeset statusconfirms 0.20.1 across the board.docs/(plane rule, hide-vs-disable, confirmation digest binding, theexplainSurfacebuild-enforced boundary) and keep the honest non-claims: no same-realm isolation, no exactly-once, no forced cancellation.pnpm docs:buildpasses; the built HTML contains the social link, edit link, and footer. I could not screenshot the running site — port 5173 was held by another project's VitePress and the browser preview policy check never cleared, so verification is from built output rather than a rendered page.Unrelated and left alone:
.changeset/README.md:11links../docs/project/12-roadmap.md, which does not exist in this repo.