Documentation

This site is the product's front door. A feature, connector, pack or command without a page here is not finished.

The rulesCopy Anchor Link

1. Every user-facing change ships with its page in the same pull request: a guide for BIM users, a reference entry for commands, and a build page for extension points.
2. Write for the reader who doesn't code. BIM professionals and managers first; technical detail goes under "Build on bimai".
3. Be honest about status. Every page that describes something not yet built says so, with the Status marker.
4. Show, don't describe. A diagram, an example conversation or a table beats a paragraph.
5. Checked in CI. The site must build; links must resolve; every command and every pack must have a page. A missing page fails the build.

How to add a pageCopy Anchor Link

Pages live in docs/content/docs/ as MDX. Mermaid code blocks render as diagrams.

cd docs
npm install
npm run dev      # preview on http://localhost:3000

Agents read the docs tooCopy Anchor Link

The site publishes llms.txt and a Markdown version of every page, so bimai's own agents (the Mentor in particular) answer "how do I…" questions from the same documentation people read.