AIV documentation map
This map separates authored product guidance from examples, benchmark evidence, generated output, and internal review records. Readers can follow the public path without navigating research artifacts.
Start here
- README: product overview and entry points.
- Quick start: build, choose a profile, run locally/strictly.
- Hello World: exercise all 16 gates one by one.
- Gate map: open one gate.
- Module adoption guide: mandatory/optional modules and profiles.
- Architecture: eight PNG figures with detailed explanations.
Public product guides
Developer and architecture references
Narrative and diagrams
| Artifact |
Purpose |
| Technical article |
long-form technical narrative |
| images/ |
architecture and gate diagrams used by the docs |
Evidence and review records
| Location |
Classification |
benchmarks/airflow-bench-compare/ |
regression/experimental evidence with methodology limits |
benchmarks/proposal-pilot/ |
proposal-check pilot outputs |
docs/reports/ |
query examples and generated evidence support |
docs/apache/ |
historical ecosystem analysis, not primary product positioning |
Generated Markdown
Files under benchmark results/ directories are generated evidence. They should be regenerated by their owning script rather than manually rewritten for tone. Public product claims must not be inferred from generated fixture summaries without reading the methodology.
Examples and integrations
| Location |
Purpose |
example-project/ |
consumer configuration/workflow example |
demos/public-seed/ |
small pass/fail demonstration fixtures |
integrations/aidlc/ |
standalone adapter and complete AI-DLC plugin source |
presets/ |
explicit starter policies |
scripts/ |
install/version/doc validation helpers |
Documentation validation
python scripts/validate-docs.py
python docs/images/validate_visuals.py
The doc validator checks all local Markdown links, all 24 module READMEs, prohibited punctuation, stale image references, and minimum module-guide sections.
Author: Viquar Khan