Pick one based on who you are. Each is a 1-page on-ramp.
-
user.adoc— install + run a scan. -
developer.adoc— clone + extend a rule. -
maintainer.adoc— deploy + monitor. -
llm-warmup-user.md— short context dump for chat-LLM users. -
llm-warmup-dev.md— context dump for coding-agent users.
-
user-guide.adoc— end-to-end usage walkthrough. -
developer-guide.adoc— adding rules, recipes, neural networks. -
admin-guide.adoc— deployment + operations. -
cicd-guidebook.adoc— CI/CD integration patterns. -
vcl-usage-guide.adoc— VCL query language reference. -
api-reference.adoc— REST / GraphQL / gRPC API reference. -
faq.adoc— frequently asked questions. -
glossary.adoc— terminology.
-
README.md— architecture overview. -
NEURAL-ARCHITECTURE.md— 8 neural networks, 6-phase blackboard. -
togaf-overview.adoc— TOGAF baseline, ADR-001..006. -
mof-metamodel.adoc— OMG MOF M2 metamodel. -
boundary-design-options.adoc— VCL / SNIF / verisimdb boundary (issue #294 decision memo). -
topology.md— ecosystem topology. -
system-integration.md— how Hypatia integrates with the wider estate.
-
README.md— design index. -
DESIGN-NARRATIVE.md— narrative design rationale. -
design-decisions.adoc— atomic decision log.
Each operations doc has a "When to update this memo" footer and explicit acceptance criteria for closing the underlying roadmap item.
-
dispatch-runner-contract.adoc— exit-code contract gitbot-fleet must implement. -
verisim-api-deployment.adoc— runbook for when the verisim-api Rust crate ships. -
migration-arangodb-to-verisim.adoc— historical migration record. -
issue-294-boundary-recommendation.adoc— A / B / C ruling memo. -
prover-wars-integration.adoc— v8.0 epic scope. -
nx-exla-neural-backend.adoc— conditional migration plan. -
containerfiles-chainguard-gap.adoc— estate Chainguard base-image audit.
-
a2ml.adoc— A2ML machine-readable metadata integration. -
k9.adoc— K9 coordination service integration. -
a2ml-k9.md— combined integration notes. -
github-registry.adoc— GitHub registry integration.
-
security/threat-model.adoc— threat model + attack surface. -
security/security-audit.adoc— security audit findings. -
governance/CRG-AUDIT-2026-04-18.adoc— CRG audit.
-
standards/crypto-standard.scm— machine-checkable crypto policy. -
standards/standardization-checklist.scm— machine-checkable standardisation policy.
-
specs/ada-tui-audit-spec.adoc— Ada TUI audit specification.
Detailed per-surface references. For the high-level overview see guides/api-reference.adoc.
-
api/cli-reference.adoc— CLI command reference. -
api/http-api.adoc— HTTP/REST + SSE + GraphQL surface. -
api/rust-api.adoc— Rust crate reference (cli, fixer, data, adapters, integration).
-
testing/needs.md— coverage targets. -
testing/audit.md— test-suite audit. -
proofs/needs.md— Idris2 proof obligations. -
proofs/gap-analysis.md— proof-coverage gap analysis.
-
readiness.md— CRG declaration + component grades. -
reports/audit/— dated audit reports. -
SESSION-LOG.adoc— long-running session record.
-
EXPLAINME.adoc— annotated tour of the codebase.
-
history/ROADMAP-v1.0.0.adoc— route-to-v1.0.0 plan (superseded by the current ROADMAP). -
history/ACTION-ITEMS.adoc— early action-item ledger (now tracked in GitHub issues). -
history/KNOWN-ISSUES.adoc— early known-issues list (now in ROADMAP "Known Gaps").
The public wiki at https://github.com/hyperpolymath/hypatia/wiki is
mirrored from docs/wiki-pages/. Wikis are a separate git repo we
can’t push to from CI; copy edits across via the wiki UI (or
git clone hypatia.wiki.git) when these files change.
-
wiki-pages/README.md— sync instructions + page mapping
Authoritative index. Whenever a new document is added (or relocated), update this file at the same time. The pattern PR is: (1) the doc change, (2) one-line addition here, (3) update of any references in the root README if the new doc warrants top-level visibility.
For a navigation taxonomy reference, see rsr-template-repo/docs/README.adoc.