Skip to content

Latest commit

 

History

History
49 lines (39 loc) · 2.51 KB

File metadata and controls

49 lines (39 loc) · 2.51 KB

DOCUMENTATION

This is the repo documentation map for Bijou. Documentation is organized by intent. Do not audit the repository by recursively walking the filesystem; follow the entrypoints below.

Current Truth

If you want the current-truth docs lane, start with the root README, this repo documentation map, and the signposts below before you drift into historical or reference material.

Entrypoints

Surface Role
README.md Public front door: package map, quick start, and positioning.
GUIDE.md Orientation: the fast path and monorepo orchestration.
DOGFOOD Canonical human-facing docs app. Run npm run dogfood.
ARCHITECTURE.md Structural reference: ports, adapters, and package responsibilities.
ADVANCED_GUIDE.md Deep dives: pipeline, motion, shaders, and proving workflows.

Doctrine and Direction

Signpost Role
VISION Core tenets and project identity.
BEARING Current direction and active tensions.
METHOD Repo work doctrine: backlog lanes and the cycle loop.
method/backlog/README.md Live queue: backlog lanes and shaped release lanes.
strategy/README.md Doctrine map: living strategy notes vs historical planning artifacts.
Design Cycles Active and landed cycle design docs.
Legends Thematic intent by lane and doctrine family.
System-Style JS Engineering doctrine: boundaries, adapters, and codecs.
Design System Foundations, patterns, and component families.

Reference

Surface Role
CLI Command surface: binaries and operator scripts.
MCP MCP server posture and tool reference.
guides/render-pipeline.md Concrete render-stage guide for configurePipeline(), RenderState, and stage-order truth.
CHANGELOG.md Historical truth of merged behavior.
ROADMAP Reference-only strategic horizon, not the active queue.
specs/README.md Legacy spec archive policy and migration rule.

For a machine-readable inventory of all documentation, run npm run docs:inventory.