Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.88 KB

README.md

File metadata and controls

33 lines (26 loc) · 1.88 KB

Shadow developer documentation

This directory is the maintained entry point for developers and reviewers. It routes a task to the narrowest durable owner without duplicating the implementation that already lives in source and tests.

Start here

Need Entry
Find the subsystem that owns a change Architecture and repository map
Build, test, format, or launch Shadow Development guide
Change an interactive adjustment or preview/render path Interactive editing pipeline contract
Change a persistent or wire contract Contract versioning
Run the local Library Server Library Server operations
Inspect repository-wide engineering constraints Project Skeleton
Review a change Review Skeleton
Coordinate work in the shared checkout Agent instructions

Navigation model

Documentation is intentionally layered:

  1. The root Project Skeleton supplies durable boundaries and routes to a concern.
  2. The root README introduces the product and the shortest working entry points.
  3. This page routes developers to architecture, development, contract, and operations documents.
  4. The repository map routes a change to one subsystem.
  5. A component README or entry module routes the change to its semantic owner.
  6. Source, schemas, build registration, and adjacent tests define current behavior.

Do not turn this directory into an exhaustive mirror of the codebase. A cross-cutting policy or operator workflow belongs here only when it has an independent audience and lifecycle. Feature status, call-by-call mechanics, and implementation inventories stay with their source owners.