DocSutra AI documentation
Complete technical, functional, architectural, executive and operational documentation. Every document exists as Markdown (documents/md) and HTML (documents/html).
Generated 2026-11-16T17:55:30.611Z on Node v24.15.0, win32/x64.
Executive summary
What DocSutra AI is, the problem it solves, what you get, and what it deliberately does not claim.
Functional specification
Exactly what the tool does from a user's point of view: commands, inputs, outputs, behaviours and exit codes.
Technical architecture
Modules, data flow, contracts, design decisions and trade-offs. Written so a new contributor can navigate the code in minutes.
User guide
Install, run, read a report, fix findings, configure, and automate. Copy-paste ready.
Rules reference
Every rule with its severity, category and evidence type. Generated from the same catalog the scanner uses, so it cannot drift.
Security and privacy
Threats considered, controls implemented, and the tests that prove each control. Limits are stated plainly.
Testing and evidence
How the claims in this project are proven, how to reproduce them, and exactly where the proof stops.
CI and integration
GitHub Actions, SARIF code scanning, pre-commit usage, other CI systems and the programmatic API.
Agent skills guide
The 16 portable skills, what backs each one, how to install them, and what is and is not verified.
Legal and trust
Licensing, names, privacy, what a report does and does not prove. Not legal advice.
Release runbook
Repeatable steps to verify, tag, publish to npm and confirm a release. Written for the maintainer.
Roadmap and FAQ
What is planned (clearly separated from what exists) and answers to common questions.