adacovex Documentation¶

This page is the index for all adacovex documentation. Pick a section relevant to you, or read the pages in the order below.

All documentation uses British English and ASD-STE100 Simplified Technical English. The controlled Technical Names dictionary lives in STE100 Technical Names. Use it before you use a technical word in any doc, docstring, or changelog.

Getting started¶

Installation – install the binary or the GitHub Action.
Target projects – what a target project must contain.

Using adacovex¶

CLI reference – every command, flag, and exit code.
Web dashboard – the HTML report and JSON API.
SBOM – the software-bill-of-materials generator.
Standards – DO-178C, ISO 26262, and IEC 62304 levels.
Platforms – supported platforms and toolchain state.
VCS support – differential assessment across git, hg, svn, fossil, and jj.
CI/CD – the GitHub Action and the workflow summary.
Changelog – release history.

Contributing to adacovex¶

Developer guide – the contributor handbook: setup, codebase tour, gates, and release workflow.
Proving and writing proofs – how to run and write SPARK proofs, including proof patches.
Architecture – the full technical design.
Requirements – the dependency categorisation.
Performance – benchmarking and optimisation history.
gnatprove-friendly IR – the design exploration for synthesising bounded, contract-carrying code.
STE100 Technical Names – the controlled dictionary.
LLM usage – guidance for AI agents.

Maintainer references¶

Proof ledger – the verified-VC history and the skipped units audit.
Compliance outputs – VERIFICATION.md, TRACE.md, and the HLR/LLR indexes.
HLR index and LLR mapping.
Badges – the badge set the self-assessment emits.
API reference – the generated package documentation.

The docs live under docs/ as a Sphinx project (docs/conf.py with MyST, plus a root docs/index.md holding the toctree). The pages are grouped by audience: docs/usage/ for end users, docs/contributing/ for contributors, and the top-level references plus docs/proof/, docs/compliance/, and docs/badges/ for maintainers. How to build the manual, regenerate the bundled offline manual, and keep the generated outputs in sync is covered in the developer guide, not here: this index stays focused on what each page contains.