# Amiss

> Amiss checks documentation against the repository tree it describes and fails the run
> when a reference stops resolving. Exit 0 is a complete pass, 1 a complete run with a
> blocking finding, 2 anything that prevented a trustworthy result. Reports are canonical
> JSON; every finding and error row carries a fixed `description` sentence stating what it
> means and what to do.

The complete book in one file: https://hardmax71.github.io/amiss/llms-full.txt

## Using Amiss

- [Introduction](https://hardmax71.github.io/amiss/introduction.html): what documentation drift the tool catches and how a run is framed
- [Documentation drift](https://hardmax71.github.io/amiss/drift.html): what drift is, the audit evidence behind the tool, and why detection gates while repair stays accountable
- [Invocation](https://hardmax71.github.io/amiss/invocation.html): the closed command grammar, the identity flags, and the three exit classes
- [Profiles and findings](https://hardmax71.github.io/amiss/profiles.html): every finding kind with its disposition, its meaning sentence, and a before/after example
- [Running it in CI](https://hardmax71.github.io/amiss/ci.html): the composite Action, the direct form, and how to read the report from a workflow
- [Working with agents](https://hardmax71.github.io/amiss/agents.html): the AGENTS.md paste block, the Claude Code plugin, and the continuous-AI repair recipe

## The evaluation

- [Snapshots](https://hardmax71.github.io/amiss/snapshots.html): the base and candidate trees, commit and staged-index addressing
- [Discovery](https://hardmax71.github.io/amiss/discovery.html): which files count as documents and which trees are always skipped
- [Resolution](https://hardmax71.github.io/amiss/resolution.html): how each destination resolves, the forge dialects, line anchors, and heading anchors
- [What ten renderers call a heading](https://hardmax71.github.io/amiss/anchor-rules.html): the pinned slugging rules, what each was checked against, and how far apart they are
- [What a documentation router serves](https://hardmax71.github.io/amiss/route-spellings.html): the harvested route spellings, the routers behind them, and what a spelling can never do
- [Correlation and impact](https://hardmax71.github.io/amiss/correlation.html): pairing occurrences across the comparison and the impact quadrant
- [The report](https://hardmax71.github.io/amiss/report.html): the canonical JSON wire, row descriptions, and the human projection
- [Limits and refusals](https://hardmax71.github.io/amiss/limits.html): every resource ceiling and every analysis error code with its meaning

## Trust

- [Security model](https://hardmax71.github.io/amiss/security.html): the zero-capability sandbox posture and hostile-input handling
- [Controls and policy](https://hardmax71.github.io/amiss/controls.html): repository policy, organization floors, debt, waivers, and trusted time
- [Provider-verified controls](https://hardmax71.github.io/amiss/provider-controls.html): the supported GitHub, GitLab, Gitea, and Forgejo lanes and their independent provider evidence
- [Prepare the execution constraint](https://hardmax71.github.io/amiss/execution-constraint.html): derive and validate the pinned action, manifest, platform, and bootstrap binding from local bytes
- [GitHub provider lane](https://hardmax71.github.io/amiss/provider-github.html): GitHub App setup, strict ruleset, service configuration, and Check Run evidence
- [GitLab provider lane](https://hardmax71.github.io/amiss/provider-gitlab.html): merge-train policy job, OIDC binding, service configuration, and job evidence
- [Gitea and Forgejo provider lane](https://hardmax71.github.io/amiss/provider-gitea.html): dedicated reviewer, strict branch rule, service configuration, and review evidence
- [Controller delivery](https://hardmax71.github.io/amiss/controller.html): authenticated delivery, temporary ownership, saved results, and retries

## The project

- [Architecture](https://hardmax71.github.io/amiss/architecture.html): how the offline crates and separate controller workspace divide the trust flow
- [Edge cases and divergences](https://hardmax71.github.io/amiss/divergences.html): the exact-wording edge cases and known parser differences
- [What Amiss is not](https://hardmax71.github.io/amiss/non-goals.html): the non-goals held deliberately
- [Amiss and link checkers](https://hardmax71.github.io/amiss/comparison.html): what lychee does well, what only two-snapshot comparison can see, and when to run both
- [The evidence base](https://hardmax71.github.io/amiss/evidence.html): the audited repository that generated the requirements
- [Provenance](https://hardmax71.github.io/amiss/provenance.html): how the tool became what it is and what was discarded on the way
- [Development](https://hardmax71.github.io/amiss/development.html): building, the gates, and the push ratchets
- [Project status](https://hardmax71.github.io/amiss/status.html): what is delivered, source-built, self-asserted, or not yet built
- [The scan ledger](https://hardmax71.github.io/amiss/ledger.html): the counted shadow scans behind the validation phase, one recorded row per repository
- [Retained provider runs](https://hardmax71.github.io/amiss/provider-evidence.html): live positive and revoked-control runs per provider, with the version, controller commit, and provider evidence
- [Completed phases](https://hardmax71.github.io/amiss/completed-phases.html): the closed phases, one page per claim, each stating what it defends and where it landed
- [Roadmap](https://hardmax71.github.io/amiss/roadmap.html): what comes next and in what order