Documentation
How ci-parity works, what it reads and reports, and how it is built, tested, secured and released. The same pages are published, with search, at https://ci-parity.is-a.dev.
Documentation index
Section titled “Documentation index”| Section | Covers |
|---|---|
| Guides | Getting started, configuring, adopting with a baseline, fixing findings, CI setup, recipes per runner, why ci-parity, and the FAQ |
| Rules | P001 to P005: what each catches, an example, and how to fix or allow it |
| Reference | The contract: configuration, the baseline, how workflows and runner files are read, the rules and their messages, the CLI and exit codes, the output formats and the GitHub Action |
| Architecture | The system context, the packages and their ports, the check, fix and release flows, and the design decisions |
| Releases and CI | The CI jobs, the check table and badges, the main ruleset, and how a release and the Marketplace listing are published |
| Testing | Golden fixtures, fix fixtures, unit and use-case tests, the action’s tests, and the field trial on public repositories |
| Security | The threat model, the action’s input handling, the supply chain and the repository controls |
Related documentation
Section titled “Related documentation”| File | Covers |
|---|---|
| README.md | What ci-parity is, the status badges, a quick start and the architecture diagram |
| CONTRIBUTING.md | Setup, every task, tests, commits and signing, hooks, pull requests and releases |
| AGENTS.md | Rules for coding agents |
| ACCESSIBILITY.md | The accessibility goal for output and docs, known gaps and the rules for changes |
| SECURITY.md | How to report a vulnerability, and what’s in scope |
| CHANGELOG.md | Every release, written by Release Please; also published on the site |
Contributing to the docs
Section titled “Contributing to the docs”Follow the style guide.
Last reviewed: 2026-10-28