Guides

Practical how-to guides for working with Canon.

Authoring

• Writing Specs — Spec authoring guide with format reference and examples
• Example Specs — Real-world examples showing how to write Canon specs for different scenarios

Deployment

• Self-Hosting — Deploy Canon to your own Kubernetes cluster
• GitHub App Setup — Configure the Canon GitHub App

Integration

• Ticket Sync — Connect specs to Jira, Linear, or GitHub Issues
• GitHub Actions — Drop Canon checks into your CI/CD pipeline with the official action suite

Extensions

• Extensions — Install community extensions or build your own for org-specific workflows
• Creating Extensions — Build your own Canon extensions to add org-specific workflows or custom automation
• Testing Extensions Locally — Hands-on guide to testing the extension system end-to-end on your local machine

Reference

• FAQ — Common questions about Canon
• Troubleshooting — Common issues and how to resolve them