You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Keep documentation validation independent from optional full-suite test dependencies while making missing test dependencies fail early with an actionable install path. Preserve historical documentation by indexing it instead of deleting or moving evidence files.
Constraint: Local base installs may not include dev-only packages such as hypothesis, but full-suite tests require them.
Rejected: Add hypothesis to runtime base dependencies | property-based tests are a dev/test concern, not runtime surface.
Rejected: Hardcode /private/tmp/teaagent-test-deps in docs verification | local temp paths are not portable project contracts.
Confidence: high
Scope-risk: moderate
Directive: Keep docs-only gates free of full test collection unless the gate also owns dev dependency setup.
Tested: bash scripts/verify_docs.sh; ruff check teaagent/ tests/; ruff format --check teaagent/ tests/; mypy teaagent/ tests/; PYTHONPATH=/private/tmp/teaagent-test-deps python3 scripts/run_test_tier.py --tier smoke; PYTHONPATH=/private/tmp/teaagent-test-deps python3 scripts/run_test_tier.py --tier acceptance; targeted docs, dependency, and hypothesis pytest suites.
Not-tested: Full python3 -m pytest -q completed end-to-end; one run was externally terminated at 37% with exit code 152 before targeted tier verification.
Copy file name to clipboardExpand all lines: docs/INDEX.md
+29-49Lines changed: 29 additions & 49 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,24 +1,35 @@
1
1
# TeaAgent Documentation Index
2
-
# 2026-06-06
2
+
# 2026-06-17
3
3
4
-
> **Last reviewed:** 2026-06-06
4
+
> **Last reviewed:** 2026-06-17
5
5
> **Review trigger:** New front-door docs, supersession links, or validation command changes.
6
6
7
7
This is the curated front door for TeaAgent documentation. It is intentionally
8
8
not an exhaustive file list. Use it to find the current source of truth, then
9
9
follow dated evidence documents only when you need the reasoning trail.
10
10
11
+
## Reading Model
12
+
13
+
TeaAgent docs are organized as three shelves:
14
+
15
+
| Shelf | Purpose | Reader rule |
16
+
| --- | --- | --- |
17
+
|**Current truth**| Stable files that describe what to trust or do now. | Read these first; update them when behavior, status, or gates change. |
18
+
|**Active work**| Ticket indexes, plans, and ledgers that still drive execution. | Read only when choosing or verifying current work. |
19
+
|**Historical evidence**| Dated audits, reviews, surveys, completed plans, and reasoning packages. | Do not reread by default; use [Historical Evidence Index](archive/INDEX.md) when you need provenance. |
20
+
21
+
No historical file is deleted or moved by this model. The generated
22
+
[Docs Inventory](generated/docs-inventory.md) remains the exhaustive catalog.
23
+
11
24
## Start Here
12
25
13
26
| Need | Start here | Status rule |
14
27
| --- | --- | --- |
15
28
| What can the owner-operator trust today? |[Daily-Driver Current Status](daily-driver-current-status.md)| Current truth for owner-operated daily use; update whenever TUI, chat, agent mode, approval, cost, undo, or resume behavior changes. |
16
-
|What is the current documentation-state assessment? |[Documentation State Review](analysis/documentation-state-review-2026-06-04.md)|Current dated evidence for corpus shape, drift risks, and consolidation priorities. |
29
+
|Which docs should I read, skip, or treat as history? |[Historical Evidence Index](archive/INDEX.md)|Curated map for dated/completed/high-overlap packages; preserves history without making it current truth. |
17
30
| What is the documentation operating model? |[Documentation Operating Model](governance/documentation-operating-model-2026-06-04.md)| Governance rulebook for claim types, TTL, owners, supersession, and CI guard targets. |
18
31
| What should be done next? |[Work Direction Execution Index](plans/work-direction-execution-index-2026-06-10.md)| Sprint 1 truth pass (WDA-001, WDB-001, WDB-003, WDG-001/002) after the June 10 critical review. |
19
32
| How should ADR 0032 M1-M6 be executed? |[ADR 0032 M1-M6 Work Plan](plans/adr-0032-m1-m6-work-plan-2026-06-13.md)| Event-spine migration plan for audit, receipts/evidence, gates, hooks, ContextBus, and webhooks. |
20
-
| Documentation corpus optimization |[Documentation Optimization Master Plan](plans/documentation-optimization-master-plan-2026-06-04.md)| Execution plan for reducing drift and improving discoverability. |
21
-
| What are the concrete work items? |[Documentation Optimization Work Items](work-log/documentation-optimization-work-items-2026-06-04.md)| Task ledger with priority, status, dependencies, and acceptance criteria. |
22
33
| Exhaustive docs inventory (generated) |[Docs Inventory](generated/docs-inventory.md)| Deterministic catalog; not current truth — use this index table first. |
| June 10 conversation experience refresh |[General-User Conversation Experience Refresh](analysis/conversation-experience-refresh-2026-06-10.md)|
68
-
| June 10 competitor analyses vs self consolidation |[Competitor Analyses vs Self Consolidation](analysis/competitor-analyses-vs-self-consolidation-2026-06-10.md)|
69
-
| June 10 public reasoning ledger |[System Review Reasoning Ledger 2026-06-10](analysis/system-review-reasoning-ledger-2026-06-10.md)|
70
-
| June 10 work direction decomposition |[Work Direction Decomposition](plans/work-direction-decomposition-2026-06-10.md)|
71
-
| June 4 project-state fact check |[Project State Cross-Review Fact Check](analysis/project-state-cross-review-fact-check-2026-06-04.md)|
72
-
| June 4 total review |[Total Review Index](analysis/total-review-2026-06-04-INDEX.md)|
73
-
| June 4 documentation critique |[Documentation Critical Questioning](reviews/documentation-critical-questioning-2026-06-04.md)|
74
-
| June 1 daily-driver review package |[Daily-Driver Review Package Index](analysis/daily-driver-review-INDEX-2026-06-01.md)|
75
-
| Active daily-driver finding closure |[Active Findings Status Ledger](analysis/active-findings-status-ledger-2026-06-06.md)|
76
-
| Markdown governance review |[Markdown Status Review](analysis/markdown-status-review-2026-06-02.md)|
77
-
| Competitor signal survey |[Competitor Signal Survey](analysis/competitor-signal-survey-2026-06-06.md) (June 4 snapshot: [2026-06-04](analysis/competitor-signal-survey-2026-06-04.md)) |
| Dynamic skill and long-result audit |[Dynamic Skill Generation And Long Result Audit](analysis/dynamic-skill-generation-and-long-result-audit-2026-06-05.md)|
80
-
| RSS dynamic skill failure case study |[RSS Dynamic Skill Failure Case Study](analysis/rss-failure-case-study-2026-06-05.md)|
| Historical daily-driver critique and counterarguments |[Daily-Driver Critique And Counterarguments](reviews/daily-driver-critique-and-counterarguments-2026-06-04.md)|
| Historical daily-driver red-team review |[Daily-Driver Red Team Review](reviews/daily-driver-red-team-review-2026-06-02.md)|
74
+
Evidence packages are historical unless this index names them as current truth.
75
+
Use this short list instead of scanning every dated analysis file.
76
+
77
+
| Need | Start here | Status |
78
+
| --- | --- | --- |
79
+
| Current direction and scope |[Harness-First Direction](strategy/harness-first-direction-2026-06-13.md)| Current direction record. |
80
+
| Latest broad review package |[System Critical Review Package 2026-06-10](analysis/system-critical-review-2026-06-10-INDEX.md)| Current dated evidence package; not timeless truth. |
81
+
| Reflective intent review |[Intent Critical Review And Worklist](analysis/intent-critical-review-and-worklist-2026-06-12.md)| Historical input to harness-first direction. |
82
+
| Documentation system review |[Historical Evidence Index](archive/INDEX.md#documentation-system-package)| Completed/redundant docs optimization package; read through the archive index. |
83
+
| Older review packages, competitor surveys, daily-driver packages, and completed plans |[Historical Evidence Index](archive/INDEX.md)| Preserved provenance; do not treat as current status. |
102
84
103
85
## Processes
104
86
@@ -216,7 +198,5 @@ for current status.
216
198
After governance-sensitive documentation edits, run:
0 commit comments