Skip to content

capabilityhostprotocol/chp-docs

Repository files navigation

chp-docs

Documentation site for the Capability Host Protocol, built with Fumadocs on Next.js 16. Intended to deploy at docs.capabilityhostprotocol.com.

Content model (hybrid)

  • Authored narrative lives in content/docs/*.mdx (Start-here, Concepts, the agent quickstart).
  • Synced reference is generated into content/docs/{reference,guides,compare} by scripts/sync-content.mjs from the sibling chp-core repo:
    • reference/specchp-core/spec/chp-v0.1.md
    • reference/schemas ← index of chp-core/schemas/*.json
    • reference/adapterschp-core/registry/adapters.json
    • guides/adapter-authoring, compare/*chp-core/docs/*

The generated files are committed to this repo. The sync runs on predev / prebuild, but it is deploy-safe: when chp-core is not present as a sibling directory (e.g. on Vercel), the sync logs a notice and keeps the committed content, so the build never depends on chp-core.

To refresh the reference after chp-core changes, run locally:

npm run sync   # regenerates from ../chp-core
git add content/docs && git commit -m "docs: refresh synced reference"

Develop

npm install
npm run dev     # http://localhost:3000

Deploy

Deploys via GitHub → Vercel (same pipeline as chp-site): push to the project's GitHub repo and Vercel builds with npm run build. Assign docs.capabilityhostprotocol.com to this project in Vercel.

Releases

No releases published

Packages

 
 
 

Contributors