- This is a documentation site built on Docusaurus
- Documentation content lives in root-level markdown and MDX files under folders like
start/,guides/,deploy/,adapters/,api/, andcli/ - Site configuration lives in
docusaurus.config.tsandsidebars.ts - Run
npm run startto preview locally - Run
npm run buildto verify the production build
- Use "company" for the top-level Paperclip organization
- Use "agent" for AI employees inside a company
- Use "issue" or "task" only when the product/UI actually uses that term
- Use "board" for the human oversight layer
- Use active voice and second person
- Keep sentences concise
- Use sentence case for headings
- Bold UI labels such as Settings
- Use code formatting for paths, commands, file names, env vars, and identifiers
- Document user-facing and operator-facing product behavior
- Avoid documenting internal-only implementation details unless the page is explicitly a spec or reference page