@@ -465,18 +465,37 @@ See [SECURITY.md](SECURITY.md) for vulnerability reporting and hardening details
465465
466466## Documentation
467467
468+ ### Core Documentation
469+
468470| Document | Description |
469471| ----------| -------------|
470472| [ ARCHITECTURE.md] ( docs/ARCHITECTURE.md ) | System design and internals |
473+ | [ API_REFERENCE.md] ( docs/API_REFERENCE.md ) | API reference for types, functions, and BPF maps |
474+ | [ DEVELOPER_GUIDE.md] ( docs/DEVELOPER_GUIDE.md ) | Development setup, coding standards, and contribution guide |
475+ | [ POLICY.md] ( docs/POLICY.md ) | Policy file format and semantics |
476+ | [ NETWORK_LAYER_DESIGN.md] ( docs/NETWORK_LAYER_DESIGN.md ) | Network blocking architecture |
477+
478+ ### Operations
479+
480+ | Document | Description |
481+ | ----------| -------------|
471482| [ PRODUCTION_READINESS.md] ( docs/PRODUCTION_READINESS.md ) | Production gates and evidence checklist |
472483| [ GO_LIVE_CHECKLIST.md] ( docs/GO_LIVE_CHECKLIST.md ) | Final go/no-go checklist for release candidates |
473- | [ BRANCH_PROTECTION.md] ( docs/BRANCH_PROTECTION.md ) | Protected-branch baseline and required checks |
474484| [ CANARY_RUNBOOK.md] ( docs/CANARY_RUNBOOK.md ) | Staging canary and soak validation workflow |
475485| [ RELEASE_DRILL.md] ( docs/RELEASE_DRILL.md ) | Pre-release packaging and upgrade drill |
476486| [ KEY_MANAGEMENT.md] ( docs/KEY_MANAGEMENT.md ) | Policy signing key rotation and revocation runbook |
477- | [ SUPPORT_POLICY .md] ( docs/SUPPORT_POLICY .md ) | Supported versions, compatibility, and deprecation guarantees |
487+ | [ INCIDENT_RESPONSE .md] ( docs/INCIDENT_RESPONSE .md ) | Incident handling procedures |
478488| [ TROUBLESHOOTING.md] ( docs/TROUBLESHOOTING.md ) | Common issues and solutions |
479489| [ SIEM_INTEGRATION.md] ( docs/SIEM_INTEGRATION.md ) | Splunk, ELK, QRadar integration |
490+
491+ ### Reference
492+
493+ | Document | Description |
494+ | ----------| -------------|
495+ | [ SUPPORT_POLICY.md] ( docs/SUPPORT_POLICY.md ) | Supported versions, compatibility, and deprecation guarantees |
496+ | [ COMPATIBILITY.md] ( docs/COMPATIBILITY.md ) | Kernel and version compatibility matrix |
497+ | [ PERF.md] ( docs/PERF.md ) | Performance tuning and benchmarking |
498+ | [ BRANCH_PROTECTION.md] ( docs/BRANCH_PROTECTION.md ) | Protected-branch baseline and required checks |
480499| [ CHANGELOG.md] ( docs/CHANGELOG.md ) | Version history |
481500| [ aegisbpf.1.md] ( docs/man/aegisbpf.1.md ) | Man page |
482501
0 commit comments