Docs
Conventions & scopes
Define coding rules and control which ones reach AI agents.
Conventions are grouped by category (code, security, testing, etc.). Each group is an array of convention blocks with a title and items.
Convention scopes
Each convention block can have an optional scope field:
- —'agent-only' — included only in AI-facing output files, excluded from human docs
- —'human-only' — excluded from all generated AI output
- —omitted — included everywhere
Example
typescript
conventions: {
security: [
{
title: 'Auth',
items: ['Use JWT tokens', 'Rotate secrets quarterly'],
scope: 'agent-only',
},
],
testing: [
{
title: 'Coverage',
items: ['Aim for 80% coverage', 'Test edge cases'],
},
],
},