# Documentation index

- [Installation](installation.md) — portable archives, WinGet, Cloudsmith APT, and source builds.
- [Architecture](ARCHITECTURE.md) — how discovery, parsing, graph construction, scoring, and reporting fit together.
- [Configuration](CONFIGURATION.md) — `.credscope.yml` reference and the JSON report schema v2 migration.
- [Inputs](inputs.md) — CLI flags and GitHub Action inputs.
- [Reporting](reporting.md) — terminal, HTML, JSON, SARIF, and Mermaid report formats.
- [Rules](RULES.md) — the rule catalog.
- [Scoring](SCORING.md) — the scoring policy.
- [Threat model](THREAT_MODEL.md) — security boundaries and guarantees.
- [Test corpus](TEST_CORPUS.md) — the deterministic, offline corpus exercising the real analysis pipeline.
- [GitHub Action usage](github-action.md) — using CredScope as a GitHub Action.
- [Releasing](RELEASING.md) — maintainer-only release process.

See the [project README](../README.md) for a general overview and quick start.