Skip to main content

Working on the docs

This page is for people editing the site, not for learning the platform. Start at how it hangs together.

Sections​

SectionFor
How it hangs togetherThe public spine
GuidesStart the stack, send a request, author an agent
ConceptsVocabulary you attach to a route, and what happens when a request runs
ArchitectureWhy the fabric exists, who owns what, internals, one page per box
AutonomyWho picks the next step (modes 0–3)
Use casesCaller and process shapes
ReferenceFrozen fixtures and stub auth

Engineering material that is not published with this site:

PathRole
tasks/Engineering plans
intent/The v1 lock
diagram-sources/Diagram generators
agent-fabric-scripts/Compose and seed scripts
agent-fabric-mocks/Domain HTTP doubles

Run the site​

cd agent-fabric-docs
npm install
npm start # dev server with hot reload
npm run build # production build; fails on broken links
npm run diagrams # regenerate static/diagrams from diagram-sources/

Order in the sidebar comes from the numbered folders under docs/ and the _category_.json beside them.