D17 documentation

A standalone Fumadocs and Scalar documentation site for the D17 launch mechanism.

The site starts with a plain-language explanation and role-based guides for participants and deployers, then continues into architecture, deployments, exhaustive ABI-derived contract references, self-hosting, realtime behavior, and a complete OpenAPI reference.

Run locally

Requirements: Node.js 22.13 LTS or Node.js 24+.

npm ci
npm run dev

Open the URL printed by Next.js. Narrative documentation is under /docs; the Scalar API reference is under /api-reference.

Validate

npm run check

The check deliberately does not regenerate committed references. It verifies TypeScript and ESLint, checks the frozen source provenance, proves every ABI entry is represented, requires a success response for every OpenAPI operation, resolves OpenAPI $ref values, checks local documentation links, scans public text for environment-specific leaks, and runs a production build. This makes stale or accidentally edited generated output fail rather than silently repairing itself.

After intentionally reconciling a new contract or API release, run:

npm run generate
npm run check

Source-of-truth inputs

• data/abi/*.abi.json — nine canonical production contract ABIs
• data/deployments/*.json — Sepolia and Ethereum mainnet public manifests
• data/reference-provenance.json — reconciled hashes, entry counts, and route counts for accidental-omission detection
• scripts/openapi-source.mjs — explicit contract for the optional read API

Generated contract pages live under content/docs/contracts/reference/. Do not hand-edit those nine files; change the generator or ABI input and run npm run generate:contracts.

The optional API is read-only. It can use any compatible Ethereum JSON-RPC endpoint and never needs a wallet key. All transactions are signed through the user's wallet directly against Ethereum contracts.

Publish

This repository is ready for an ordinary Next.js Vercel project. With no environment variables, / opens the narrative documentation at /docs.

To publish separate guide and API-reference deployments from the same source, set these non-secret server-side project variables.

Guide project:

D17_DOCS_HOME=docs
D17_API_REFERENCE_ORIGIN=https://your-api-reference.example

API-reference project:

D17_DOCS_HOME=api
D17_GUIDE_ORIGIN=https://your-guide.example

The guide root opens /docs, and API-reference links move to the API project. The API root opens /api-reference, and guide links move to the guide project. With no variables, local development keeps both route trees available. No D17 read-API hostname or credential is required by either documentation deployment.

License

MIT. See LICENSE. Documentation is educational material for experimental software, not investment advice.