docs: document safety, lint and policy rules for check
VA
10h ago+107+107+012345678901234567890123456789-10-10-01234567890123456789
Issue for this PR
Fixes #1125
Type of change
- Bug fix
- New feature
- Refactor / code improvement
- Documentation
What does this PR do?
Adds catalogs for safety, lint and policy rules observed from altimate-core 0.9.0, with triggering examples and severities. Links the catalogs from Available Checks and corrects the SELECT * example to L001 / select_star.
How did you verify your code works?
- From
docs/:mkdocs build --site-dir /tmp/altimate-docs-sitepasses with no new diagnostics against the base. - Ran all 55 safety/lint examples and 11 policy examples through the CLI. Every documented rule and severity matched.
bun run typecheck: 13 workspace checks pass.
Selected finding fields from the CLI output:
{
"safety": {
"rule": "unbalanced_quote",
"severity": "error"
},
"lint": {
"rule": "select_star",
"code": "L001",
"severity": "warning"
},
"policy": {
"rule": "require_limit",
"severity": "error"
}
}
Cost side effects
None. No additional model calls, remote warehouse queries or cloud resources.
Screenshots / recordings
Not a UI change.
Checklist
- I have tested my changes locally
- I have not included unrelated changes in this PR
- I checked for cost side effects and described them above
Drafted-by: Codex (GPT-6); reviewed by @Vamsi-klu before posting
Summary by CodeRabbit
- Documentation
- Added a Rule Catalog covering observed safety and lint rules, their examples and severities, and policy-rule configuration.
- Linked check descriptions to relevant catalog sections and clarified that lint findings may omit rule and code fields.
- Updated JSON and text examples to show a
select_starfinding with codeL001. - Documented catalog limitations and how check errors are represented when an engine call fails.