victus-docs is the documentation control plane for the Victus ecosystem.
It exists to give humans and AI agents one stable place to understand system context, shared contracts, architecture decisions, and repository boundaries.
| Reader | First file | Purpose |
|---|---|---|
| Human | 000-SYSTEM-CONTEXT.md | Canonical documentation convention and system context |
| AI agent | AGENTS.md | Repository rules and required reading order |
| Architecture reviewer | 100-ARCHITECTURE.md | Architecture map and system principles |
| Operations reviewer | 200-OPERATIONS.md | Documentation operations and validation |
| Contract reviewer | 300-CONTRACTS.md | Stable cross-repository expectations |
repos/**Source changes belong in the owning repository.
Victus documentation uses a hybrid Hub-and-Node convention. Root numbered files are Maps of Content; detailed documents remain in their owning folders.
| Path | Role |
|---|---|
| 000-SYSTEM-CONTEXT.md | System context and documentation convention |
| 100-ARCHITECTURE.md | Architecture Map of Content |
| 200-OPERATIONS.md | Operations Map of Content |
| 300-CONTRACTS.md | Contracts Map of Content |
| decisions/ | Root decision hub |
| docs/contracts/artifacts.md | Artifact contract hub |
| docs/contracts/repository-documentation-contract.md | Repository documentation contract |
| docs/adr/index.md | Architecture decisions |
| repos/ | Read-only synchronized repository documentation |
| Repository | Responsibility |
|---|---|
victus-docs |
Global documentation, contracts, ADRs, and agent-readable navigation |
victus-infra |
Infrastructure, networking, storage, secrets, observability, and deployment foundation |
victus-processing |
Paper ingestion, extraction, chunking, claims, and embeddings |
victus-rag |
Retrieval, vector database integration, API orchestration, prompts, and answers |
This repository is primarily Markdown documentation. Useful sanity checks are:
git status --short
find docs -type f -name '*.md' -print
Before publishing documentation changes, confirm changed files are intentional and links still point to existing files.