Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/evidence/DOC_MAP_BENCHMARK.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Documentation Map: Benchmark Docs

| Document | Purpose | Location |
|----------|---------|----------|
| BENCHMARKING.md | Benchmark plan and targets | docs/evidence/BENCHMARKING.md |
| METRICS_CURRENT.md | Current benchmark results | docs/evidence/METRICS_CURRENT.md |
| BENCHMARK_GOVERNANCE.md | Benchmark policies | docs/evidence/BENCHMARK_GOVERNANCE.md |
| SIMULATION_BENCHMARK.md | Simulation module evaluation | docs/evidence/SIMULATION_BENCHMARK.md |
| Concept card: benchmark caveat | Benchmark limitations | docs/evidence/CONCEPT_CARD_BENCHMARK_CAVEAT.md |
8 changes: 8 additions & 0 deletions docs/evidence/DOC_MAP_COMMAND.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Documentation Map: Command Docs

| Document | Purpose | Location |
|----------|---------|----------|
| COMMAND_SURFACE.md | CLI command reference | docs/getting-started/COMMAND_SURFACE.md |
| QUICKSTART.md | Quickstart guide | docs/getting-started/QUICKSTART.md |
| CLADUE.md | Agent guidance | CLAUDE.md |
| Exit code registry | Exit code meanings | configs/exit_code_registry.json |
13 changes: 13 additions & 0 deletions docs/evidence/DOC_MAP_FILE_OWNERSHIP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Documentation Map: File Ownership

| Path | Owner | Review Required |
|------|-------|:---------------:|
| src/openamp_foundry/ | Maintainer | Yes |
| tests/ | Maintainer | Yes |
| docs/ | Maintainer | For new docs |
| configs/ | Maintainer | Yes |
| schemas/ | Maintainer | Yes |
| scripts/ | Maintainer | For new scripts |
| Makefile | Maintainer | Yes |
| README.md | Project lead | Yes |
| AGENTS.md | Project lead | Yes |
9 changes: 9 additions & 0 deletions docs/evidence/DOC_MAP_ISSUE_TAXONOMY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Documentation Map: Issue Taxonomy

| Label Category | Labels | Purpose |
|---------------|--------|---------|
| Type | bug, enhancement, docs, test | What kind of change |
| Area | safety, benchmark, calibration | Which part of the project |
| Priority | P0, P1, P2, P3 | Urgency |
| Status | good-first-issue, help-wanted | Contributor targeting |
| Process | urgent, needs-design, blocked | Workflow state |
9 changes: 9 additions & 0 deletions docs/evidence/DOC_MAP_RELEASE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Documentation Map: Release Docs

| Document | Purpose | Location |
|----------|---------|----------|
| PUBLICATION_PACK.md | Release checklist | docs/review/PUBLICATION_PACK.md |
| RELEASE_DRY_RUN_GUIDE.md | Dry-run reading guide | docs/review/RELEASE_DRY_RUN_GUIDE.md |
| RELEASE_DRY_RUN_WALKTHROUGH.md | Dry-run walkthrough | docs/review/RELEASE_DRY_RUN_WALKTHROUGH.md |
| RELEASE_CHECKLIST.md | Release process | docs/trust/RELEASE_CHECKLIST.md |
| METRICS_CURRENT.md | Current metrics | docs/evidence/METRICS_CURRENT.md |
9 changes: 9 additions & 0 deletions docs/evidence/DOC_MAP_REVIEW.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Documentation Map: Review Docs

| Document | Purpose | Location |
|----------|---------|----------|
| EXPERT_REVIEW_PACK.md | Review packet contents | docs/review/EXPERT_REVIEW_PACK.md |
| LAB_PARTNER_ONBOARDING.md | CRO onboarding | docs/review/LAB_PARTNER_ONBOARDING.md |
| RELEASE_DRY_RUN_GUIDE.md | Dry-run interpretation | docs/review/RELEASE_DRY_RUN_GUIDE.md |
| PUBLICATION_PACK.md | Publication preparation | docs/review/PUBLICATION_PACK.md |
| WET_LAB_HANDOFF.md | Wet-lab procedures | docs/review/WET_LAB_HANDOFF.md |
8 changes: 8 additions & 0 deletions docs/evidence/DOC_MAP_ROADMAP.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Documentation Map: Roadmap Docs

| Document | Purpose | Location |
|----------|---------|----------|
| ROADMAP.md | Shipped milestones and next horizons | docs/research/ROADMAP.md |
| 50_LOOP_PLAN.md | 50-loop execution plan | docs/50_LOOP_PLAN.md |
| NEXT_100_PR_MAP.md | Sequenced infrastructure backlog | docs/research/NEXT_100_PR_MAP.md |
| WAVE2_PLAN.md | Wave 2 planning | docs/research/WAVE2_PLAN.md |
13 changes: 13 additions & 0 deletions docs/evidence/DOC_MAP_SOURCE_OF_TRUTH.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Documentation Map: Source of Truth

Defines which document is authoritative for each topic.

| Topic | Source of Truth | Backup/Reference |
|-------|----------------|-----------------|
| Pipeline metrics | `docs/evidence/METRICS_CURRENT.md` | Benchmark outputs |
| Evidence schema | `schemas/candidate.schema.json` | `docs/evidence/EVIDENCE_CERTIFICATE.md` |
| Lab result schema | `schemas/lab_result.schema.json` | `docs/review/WET_LAB_HANDOFF.md` |
| Benchmark governance | `docs/evidence/BENCHMARK_GOVERNANCE.md` | `docs/evidence/BENCHMARKING.md` |
| Calibration policy | `configs/recalibration_policy.yaml` | `docs/evidence/CALIBRATION_POLICY.md` |
| Safety policy | `SAFETY.md` | `RESPONSIBLE_USE.md` |
| Agent contract | `AGENTS.md` | `AGENT_TASKS.json` |
12 changes: 12 additions & 0 deletions docs/evidence/GLOSSARY_LEARNING_SEQUENCE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# Glossary Learning Sequence

Recommended order to learn project terminology.

1. **Evidence** — what constitutes proof at different levels (PROOF_LADDER.md)
2. **Artifact** — any generated file that carries evidence (ARTIFACT_MAP.md)
3. **Schema** — machine-readable definition of an artifact's structure
4. **Manifest** — record of inputs, configs, and outputs for a run
5. **Gate** — a safety mechanism that blocks or allows an action
6. **Abstention** — when a module declines to make a prediction due to uncertainty
7. **Baseline** — a simple heuristic that any new method must beat
8. **Calibration** — adjusting model outputs based on real data
21 changes: 21 additions & 0 deletions docs/evidence/READER_SELF_ASSESSMENT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Reader Self-Assessment Checklist

Use this checklist to assess your understanding of the project documentation.

## Level 1: Can run the pipeline
- [ ] I can run `make demo` and understand the output
- [ ] I can find evidence certificates in `outputs/evidence/`
- [ ] I know what `charge_bias` means
- [ ] I understand that scores are computational, not biological proof

## Level 2: Can contribute
- [ ] I know how to find the right document from PROJECT_INDEX.md
- [ ] I can run docs checks locally
- [ ] I understand the contribution workflow from CONTRIBUTING.md
- [ ] I know how to create a PR referencing an issue

## Level 3: Can review
- [ ] I can assess a PR for overclaiming language
- [ ] I understand the benchmark limitations
- [ ] I know where to find the current metrics
- [ ] I understand the simulation module status
20 changes: 20 additions & 0 deletions tests/test_doc_maps.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
"""Tests for 10 doc maps batch."""
from pathlib import Path

FILES = [
"DOC_MAP_BENCHMARK.md",
"DOC_MAP_REVIEW.md",
"DOC_MAP_RELEASE.md",
"DOC_MAP_COMMAND.md",
"DOC_MAP_ISSUE_TAXONOMY.md",
"DOC_MAP_ROADMAP.md",
"DOC_MAP_FILE_OWNERSHIP.md",
"DOC_MAP_SOURCE_OF_TRUTH.md",
"GLOSSARY_LEARNING_SEQUENCE.md",
"READER_SELF_ASSESSMENT.md",
]


def test_all_exist():
for f in FILES:
assert Path("docs/evidence", f).exists(), f"Missing: {f}"
Loading