How-To Guides

Task-oriented guides for accomplishing specific goals with Dossier.

Available Guides

Distribution & Publishing

• Publishing npm packages - Guide for package maintainers
• Multi-registry setup - Configuring multiple registries for teams

Authoring

• Authoring guidelines - How to write dossiers that help agents succeed (declarative what/why over procedural how)
• Authoring evidence - Attach per-rule rationale and session pointers to a published dossier so later editors know why a rule says what it says

Integration

• Claude Code integration - Use dossiers from Claude Code (MCP server, install-skill, run)
• CI/CD integration - Run and verify dossiers in automated pipelines
• Signing dossiers - Sign dossiers and manage trusted keys
• Adopter playbooks - How organizations can adopt Dossier
• Dossier Guide - Deep dive into concepts, schema, security, and best practices

Contributing upstream

• Zero-trust contributions - Propose a verified fix to someone else’s open-source project from an isolated VM; you submit every comment and pull request yourself

Observability

• Execution tracing - Record agent runs to a queryable registry; self-host your own trace DB

Can’t Find What You Need?

• Check Tutorials for step-by-step learning
• See Reference for technical specifications
• Browse Examples for code samples
• Ask in GitHub Discussions

Rendered from docs/guides/README.md in the repository. Edit it there.