Overview
About this documentation
How this documentation is written, how it is kept honest, and what its status labels and source citations are actually promising you.
This documentation describes the product as it is built, not as it is planned or as it once was.
Two trees
| Tree | Read it |
|---|---|
| Reference Guide | In order. It is the narrative: what GovIntel is, how it runs, what it scores, what it will not claim. |
| Wiki | By lookup. One canonical page per concept, cross-linked. Every term the Guide uses is defined here exactly once. |
Nothing is explained twice. Where the Guide uses a term, it links to the Wiki page that owns it.
Every page carries a status
Current, Deprecated, Planned, Experimental or Unverified. The label is part of the claim. See Status legend.
Every page names its sources
The rail on each page lists the files the page's claims derive from. A page that states a threshold without naming where the threshold lives is a page that goes stale silently the next time the threshold moves.
What keeps it honest
The documentation is built from the same repository as the product, and the build enforces three things:
- Constants are not retyped. Thresholds, weights and permission lists are
generated from the configuration files the engine actually reads.
- Claims are tested. The build fails if a page promises a response time, an
SLA, an uptime figure, an audit standing, a certification, or a compliance framework mapping — because the product provides none of those.
- Links are tested. Every internal link, in the prose and in the navigation,
must resolve to a page that exists.