PyGuard’s documentation is organized around how teams actually adopt the tool: start fast, automate scans, then go deep on reference material when needed. Everything here keeps the “developer-first and easy-to-run” philosophy intact.
| Resource | Why it matters |
|---|---|
| README | Product overview, capabilities map, CLI summary |
| Quickstart | Install, run first scan, automate in <10 minutes |
| Troubleshooting | Fast answers for installation, scanning, CI, and reporting issues |
| Examples | Copy-paste demos for API usage, integrations, notebook scans, and plugins |
| Topic | Key guides |
|---|---|
| Command reference & UX | Quickstart, RipGrep Integration, Watch Mode |
| Auto-fix workflows | Auto-Fix Guide, Notebook Security |
| Configuration | Plugin Architecture, Advanced Integrations, Custom Rules Demo |
| Reporting | Compliance Reporting, GITHUB_ACTION_QUICK_REFERENCE |
| Git hooks & local automation | Git Hooks Guide, pyguard-hooks CLI |
| Workflow | Guides & references |
|---|---|
| CI/CD (GitHub, GitLab, Jenkins, Azure Pipelines) | GitHub Action Guide, Advanced Integrations |
| Marketplace distribution | GitHub Marketplace Guide, Distribution Strategy |
| Air-gapped / offline | Air-Gapped Installation, Reproducible Builds |
| SBOM & compliance exports | Supply Chain Security, SBOM Guide |
| Performance tuning | Performance & Benchmarks, Incremental Analysis |
| Area | Resources |
|---|---|
| Capabilities & rules | Capabilities Reference, Security Rules, Suppression Syntax |
| Architecture & implementation | Architecture Overview, Implementation Summary, Autofix Analysis |
| APIs & extensibility | API files, JSON-RPC API, Webhook API |
| Testing strategy | TEST_PLAN, COMPREHENSIVE_TEST_PLAN, Development testing guide |
| Historical reports | Reports index with deep dives, enhancements, and roadmap execution logs |
| Topic | Resources |
|---|---|
| Security policy & disclosures | SECURITY.md, Security Quickstart |
| Threat modeling | Threat Model, Risk Ledger |
| Release integrity | SLSA Provenance Verification, Signature Verification, GPG Verification |
| SBOM & dependency posture | SBOM Guide, Dependency Management |
| Workflow security | WORKFLOW_SECURITY_CHECKLIST, Workflow Security Guide |
- ROADMAP — strategy toward v1.0 and beyond
- CHANGELOG — release notes
- CONTRIBUTING & CODE_OF_CONDUCT — how to collaborate respectfully
- COMPREHENSIVE_TEST_PLAN & coverage dashboards — quality benchmarks
- Documentation Manifest — auto-generated index of every Markdown file with titles & summaries
- Docs tone guide — follow this when extending documentation
Need help? Open an issue or start a discussion.