Skip to content

Latest commit

 

History

History
88 lines (70 loc) · 4.24 KB

File metadata and controls

88 lines (70 loc) · 4.24 KB

vBook Documentation

This directory uses numbered documentation layers. Start here before reading implementation code or dated progress logs.

Production Status Entry Point

From the repository root, run vstatus to inspect the current cross-project production workflow without changing production data:

Need Command
Current overview .\vstatus
Periodic refresh .\vstatus watch
Lesson pipeline .\vstatus lesson "<lesson-name>"
Run details .\vstatus run <run-id>
Task attempts .\vstatus task <task-id>
Stage wave .\vstatus wave <stage> <number>
Machine-readable output .\vstatus json [output-file]
Strict health gate .\vstatus check
Command help .\vstatus help

The overview covers vBook orchestration, vtext progress, vision/fusion quality, run evidence, pause/stop controls, and scheduler freshness. Read the production workflow status runbook for field interpretation, exit codes, aliases, and advanced options.

Fast Reading Path

For project orientation:

  1. 00_project/overview.md
  2. 00_project/glossary.md
  3. 00_project/status.md
  4. 00_project/task-board.md
  5. 00_project/roadmap.md

For development work:

  1. 00_project/glossary.md
  2. 00_project/status.md
  3. 00_project/task-board.md
  4. 30_pipeline/README.md
  5. 20_architecture/README.md
  6. 40_development/README.md

For technical experiments and route comparisons:

  1. 40_development/experiment-protocol.md
  2. 60_operations/experiment-workspace.md
  3. 60_operations/experiment-workflow.md
  4. 60_operations/experiment-artifacts.md
  5. 60_operations/experiment-datasets.md
  6. 70_progress/2026-07-10-note-synthesis-experiment-plan.md

Documentation Layers

Layer Purpose
00_project/ Project positioning, glossary, scope, roadmap, and status
10_product/ User scenarios, product workflow, requirements, and acceptance criteria
20_architecture/ System architecture, module boundaries, data contracts, and decisions
30_pipeline/ Stage-by-stage media-to-knowledge pipeline documentation
40_development/ Setup, commands, testing, Git workflow, and agent collaboration
50_modules/ Package-level documentation for vbook_* modules
60_operations/ Local runs, smoke tests, troubleshooting, and artifact cleanup
70_progress/ Status snapshots, backlog, milestones, and dated progress logs
80_superpowers/ Agent specs, implementation plans, reviews, and handoffs
90_reference/ Original requirements, external references, and vtext boundary material

Migrated Source Documents

The original documents now live in the numbered layers:

vBook can learn from vtext's project structure and workflow ideas, but it must remain an independent project with independent modules, interfaces, and evolution.