Skip to content

Commit ac9af33

Browse files
committed
docs: add argus.yml configuration reference
Add comprehensive config-reference.md documenting all argus.yml top-level keys, scanner properties, reporting, execution, containers, and DAST sections. Link from CLAUDE.md, README.md, and architecture.yaml.
1 parent 7c14f42 commit ac9af33

4 files changed

Lines changed: 424 additions & 2 deletions

File tree

.ai/architecture.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -384,6 +384,8 @@ directory_structure:
384384
"tests/": "Test infrastructure"
385385
"tests/fixtures/": "Shared test data"
386386
"docs/": "Detailed documentation"
387+
"docs/config-reference.md": "Full argus.yml configuration specification"
388+
"argus-config.schema.json": "JSON Schema for argus.yml validation and IDE support"
387389
"hardening-dagger/": "Python reporting utility (separate module)"
388390

389391
constraints:

CLAUDE.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -440,7 +440,7 @@ reporters:
440440
- sarif
441441
```
442442
443-
See `argus.example.yml` for a complete configuration reference.
443+
See `argus.example.yml` for a quick-start template, or [Configuration Reference](docs/config-reference.md) for the full specification.
444444

445445
### Composite Action Usage (GitHub Actions)
446446

@@ -552,7 +552,8 @@ Examples are automatically validated by `.github/workflows/test-examples-functio
552552
- `argus/scanners/__init__.py` - Scanner registry
553553
- `argus/reporters/__init__.py` - Reporter registry
554554
- `argus.yml` - Project scan configuration
555-
- `argus.example.yml` - Configuration reference with all options
555+
- `argus.example.yml` - Quick-start configuration template
556+
- `docs/config-reference.md` - Full `argus.yml` specification
556557
- `version.yaml` - Single version source for releases
557558
- `renovate.yaml` - Dependency update configuration
558559
- `CONTRIBUTING.md` - Composite actions contributor guide

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ See [examples/github-enterprise/](examples/github-enterprise/) for complete GHES
175175

176176
### User Guides
177177

178+
- [Configuration Reference](docs/config-reference.md) - Full `argus.yml` specification
178179
- [Scanner Reference](docs/scanners.md) - Complete configuration for all scanners
179180
- [Container Scanning](docs/container-scanning.md) - Config-driven matrix container scanning
180181
- [Failure Control](docs/failure-control.md) - Severity-based workflow failure configuration

0 commit comments

Comments
 (0)