bound-docs

Imported from iamnotdou/bound-docs (AGENTS.md). Install upstream with npx skills add iamnotdou/bound-docs. Copyright stays with the author.

bound-docs — the documentation site

Next.js 16 + Fumadocs. Prose lives in MDX under content/docs; everything factual about the protocol is rendered from @bound/sdk. Private repo, deployed to docs.boundprotocol.dev. npm, not pnpm — the lockfile is package-lock.json.

Definition of done

npm run build        # type-checks and prerenders every page
npm run lint

There is no CI workflow and no test suite: the Vercel build is the gate. A build failure on a missing MDX component means it was never registered in components/mdx.tsx. npm run types:check runs next typegen first, which is what generates the PageProps / LayoutProps globals the pages use.

The one rule that matters

No contract address, public key, RPC URL, package version or protocol link is written into MDX. Every such value has a component in components/protocol.tsx (<Address>, <ContractTable>, <AccountTable>, <NetworkTable>, <Sdk>, <SdkVersion>, <RpcUrl>, <NetworkName>, <ExternalLink>), backed by @bound/sdk/deployments or by lib/protocol.ts. They are registered globally, so MDX uses them without an import. Hardcoding a value is how docs start lying about a live deployment.

• New deployment → npm i @bound/sdk@latest. Nothing else changes.
• New link, package, contract blurb or actor description → lib/protocol.ts.
• A value with no component yet → add the component, then use it.

Fenced code blocks are the one exception: they are illustrative and may carry a literal demo address.

Map

Conventions

• Sidebar order is explicit. A page not listed in its folder's meta.json will not appear where you expect. Section dividers are "---Title---" entries.
• Every page is agent-readable twice. proxy.ts rewrites /docs/<path>.md and any /docs/<path> request that prefers markdown onto /llms.mdx/docs/<path>/content.md, and /llms.txt + /llms-full.txt serve the index and the whole corpus. A new route that shadows those paths breaks the machine-readable copies silently. Keep Vary: Accept on the negotiated rewrite.
• / redirects to /docs. This host serves documentation and nothing else; the marketing home is boundprotocol.dev.
• No "Edit on GitHub" link. The repo is private, so githubUrl is deliberately absent from the docs page — it would 404 for every reader.
• Tone: written for a reader deciding whether to trust the protocol, not for one who already agrees. State limits plainly. content/docs/trust-model.mdx sets the register, and content/docs/v2/open-problems.mdx keeps the unresolved parts visible rather than tidied away.
• Page frontmatter is title, description, icon (a lucide name, resolved by lucideIconsPlugin).

Connections

• @bound/sdk comes from npm and is the only source of addresses, endpoints, actor keys and deploy provenance. sdkVersion in lib/protocol.ts is read out of the installed package.json, so the docs always name the version the examples were written against.
• Contracts and the SDK live in the sibling bound repo; the app lives in bound-web. links in lib/protocol.ts is the only place those hosts are named — including links.dashboard, which still points at the landing page's /app rather than an app. subdomain.