Skip to content

Latest commit

 

History

History

README.md

Documentation

This directory contains design specifications and reference materials for Orbit.

Naming Conventions

Prefix Category Description
spec- Design specification Detailed internal design decisions and structural contracts
(none) Reference material Comparisons, guides, and other supplementary information

Document Index

Design Specifications

Document Description
spec-worktree.md The worktree model: root decision, config ownership, fetch discipline, branching strategy, push routing, git dependency closure
spec-commands.md Command interface design and argument conventions
spec-directory.md Directory structure layout and anchor rules
spec-knowledge.md Knowledge system: progressive loading, staleness detection, and memo lifecycle
spec-lifecycle.md Workspace lifecycle (new → add → done → prune, reactivation via goal)
spec-metadata.md Metadata formats (git-config INI + Markdown)
spec-warnings.md Registry of stderr guidance warnings (the steering channel) and their format contract

Reference Materials

Document Description
comparison.md Comparison with workspace management and agent context tools
recipes.md Common scenario cookbook