Skip to content

Commit 41c51fc

Browse files
committed
Clarify documentation entry points and test gates
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.
1 parent b80a005 commit 41c51fc

13 files changed

Lines changed: 241 additions & 79 deletions

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# TeaAgent
22

3-
> **Last reviewed:** 2026-06-13
3+
> **Last reviewed:** 2026-06-17
44
> **Review trigger:** README feature claims, golden path, or provider count changes.
55
> **Direction record:** [Harness-First Direction](docs/strategy/harness-first-direction-2026-06-13.md) (owner-operator harness-first current direction)
66
@@ -115,6 +115,7 @@ Same as the [golden path](#golden-path-first-hour) above. Prefer `--human` on `d
115115

116116
### 6. Docs
117117

118+
- Documentation front door: [docs/INDEX.md](docs/INDEX.md)
118119
- Quick start: [docs/USAGE.md](docs/USAGE.md)
119120
- CLI/MCP reference: [docs/cli.md](docs/cli.md)
120121
- Troubleshooting: [docs/troubleshooting.md](docs/troubleshooting.md)

docs/INDEX.md

Lines changed: 29 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,35 @@
11
# TeaAgent Documentation Index
2-
# 2026-06-06
2+
# 2026-06-17
33

4-
> **Last reviewed:** 2026-06-06
4+
> **Last reviewed:** 2026-06-17
55
> **Review trigger:** New front-door docs, supersession links, or validation command changes.
66
77
This is the curated front door for TeaAgent documentation. It is intentionally
88
not an exhaustive file list. Use it to find the current source of truth, then
99
follow dated evidence documents only when you need the reasoning trail.
1010

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+
1124
## Start Here
1225

1326
| Need | Start here | Status rule |
1427
| --- | --- | --- |
1528
| 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. |
1730
| 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. |
1831
| 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. |
1932
| 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. |
2233
| Exhaustive docs inventory (generated) | [Docs Inventory](generated/docs-inventory.md) | Deterministic catalog; not current truth — use this index table first. |
2334
| Documentation aging dashboard (generated) | [Docs Aging Dashboard](generated/docs-aging-dashboard.md) | Current-truth review freshness grouped by owner surface. |
2435
| Command snippet inventory (generated) | [Command Snippet Inventory](generated/command-snippet-inventory.md) | Guide command coverage vs smoke/manual registry. |
@@ -45,6 +56,7 @@ governance ledgers should prefer the canonical set above.
4556

4657
| Question | Canonical source |
4758
| --- | --- |
59+
| Project identity and scope | [Harness-First Direction](strategy/harness-first-direction-2026-06-13.md) |
4860
| Current owner-operated daily behavior | [Daily-Driver Current Status](daily-driver-current-status.md) |
4961
| Acceptance flow inventory | [Acceptance Coverage](acceptance.md) |
5062
| Roadmap state | [Roadmap Status](roadmap-status.md) |
@@ -55,50 +67,20 @@ governance ledgers should prefer the canonical set above.
5567
| Permission and approval behavior | [Permission And Approval Playbook](permission-and-approval-playbook.md) |
5668
| Operator trust model | [Operator Trust Model](operator-trust-model.md) |
5769
| Owner friction intake | [Operator Friction Log](work-log/operator-friction-log.md) |
70+
| Historical evidence and completed/redundant packages | [Historical Evidence Index](archive/INDEX.md) |
5871

5972
## Evidence And Review
6073

61-
| Topic | Evidence package |
62-
| --- | --- |
63-
| **June 12 reflective intent critical review** | [Intent Critical Review and Worklist 2026-06-12](analysis/intent-critical-review-and-worklist-2026-06-12.md) |
64-
| **June 10 system critical review package (current)** | [System Critical Review Package 2026-06-10](analysis/system-critical-review-2026-06-10-INDEX.md) |
65-
| June 10 engineering critique refresh | [Engineering Architecture Critique Refresh](analysis/engineering-critique-refresh-2026-06-10.md) |
66-
| June 10 remote multi-agent readiness refresh | [Remote Multi-Agent Readiness Refresh](analysis/remote-multi-agent-readiness-refresh-2026-06-10.md) |
67-
| 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)) |
78-
| Product principles | [TeaAgent Product Principles](strategy/teaagent-product-principles-2026-06-04.md) |
79-
| 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) |
81-
| Agent ecosystem core values | [Agent Ecosystem Core Values](strategy/agent-ecosystem-core-values-2026-06-05.md) |
82-
| Dynamic skill critical questioning | [Dynamic Skill Critical Questioning](reviews/dynamic-skill-critical-questioning-2026-06-05.md) |
83-
| Seven control loops competitor survey | [Seven Control Loops Competitor Survey](analysis/seven-control-loops-competitor-survey-2026-06-05.md) |
84-
| Seven control loops product direction | [Seven Control Loops Product Direction](strategy/seven-control-loops-product-direction-2026-06-05.md) |
85-
| Seven control loops critical questioning | [Seven Control Loops Critical Questioning](reviews/seven-control-loops-critical-questioning-2026-06-05.md) |
86-
| Community agent pain points | [Community Agent Pain Points Survey](analysis/community-agent-pain-points-survey-2026-06-05.md) |
87-
| June 6 system critical review package | [System Critical Review Package](analysis/system-critical-review-2026-06-06-INDEX.md) |
88-
| June 6 source-backed competitor self-comparison | [Competitor Self-Comparison Matrix](analysis/competitor-self-comparison-matrix-2026-06-06.md) |
89-
| June 6 competitive claim hygiene | [Competitive Claim Audit](analysis/competitive-claim-audit-2026-06-06.md) |
90-
| June 6 public reasoning ledger | [System Review Reasoning Ledger](analysis/system-review-reasoning-ledger-2026-06-06.md) |
91-
| June 6 critical-question map | [System Interrogation Map](analysis/system-interrogation-map-2026-06-06.md) |
92-
| June 6 engineering architecture critique | [Engineering Architecture Critique](analysis/engineering-architecture-critique-2026-06-06.md) |
93-
| June 6 multi-agent coordination critique | [Multi-Agent Coordination Critique](analysis/multi-agent-coordination-critique-2026-06-06.md) |
94-
| June 6 conversation UX analysis | [User Experience And Conversation Patterns](analysis/user-experience-and-conversation-patterns-2026-06-06.md) |
95-
| June 6 risk and trust model critique | [Risk And Trust Model Critique](analysis/risk-and-trust-model-critique-2026-06-06.md) |
96-
| Phase 0-to-1 outlook | [Phase 0 To Phase 1 Outlook](strategy/phase-0-to-phase-1-outlook-2026-06-04.md) |
97-
| Malleable governed agent harness | [Malleable Governed Agent Harness](strategy/malleable-governed-agent-harness-2026-06-03.md) |
98-
| Historical daily-driver roadmap rationale | [Daily-Driver Roadmap Rationale](strategy/daily-driver-roadmap-rationale-2026-06-04.md) |
99-
| Historical daily-driver critique and counterarguments | [Daily-Driver Critique And Counterarguments](reviews/daily-driver-critique-and-counterarguments-2026-06-04.md) |
100-
| Historical daily-driver docs package review | [Daily-Driver Docs Package Review](reviews/daily-driver-docs-package-review-2026-06-02.md) |
101-
| 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. |
10284

10385
## Processes
10486

@@ -216,7 +198,5 @@ for current status.
216198
After governance-sensitive documentation edits, run:
217199

218200
```bash
219-
python3 scripts/validate_docs_consistency.py
220-
python3 scripts/detect_stale_plans.py
221-
python3 -m pytest tests/test_docs_consistency.py tests/acceptance/test_docs_acceptance_count_accuracy.py -q
201+
python3 scripts/verify_docs.sh
222202
```

0 commit comments

Comments
 (0)