diff --git a/docs/README.md b/docs/README.md index 80f03adb3..4235c3b8c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,25 +1,19 @@ -# Orca Docs +# Orca CLI Docs -Keep this folder focused on durable design notes, implementation plans, and -feature references that are still useful after the original PR or release work -lands. +Keep this folder focused on the durable references for Orca's public CLI and runtime model. -## Current References +## Keep These Docs -- `focus-follows-mouse-design.md` - - Rationale and edge cases for focus-follows-mouse behavior. -- `focus-follows-mouse-plan.md` - - Rollout checklist and validation notes for focus-follows-mouse. -- `split-groups-rollout-pr*.md` - - Incremental split-groups rollout plans. -- `file-explorer-external-drop.md` - - Design notes for importing files from OS drag-and-drop. -- `performance-audit.md` and `performance-implementation-plan.md` - - Performance findings and planned remediation steps. -- Other feature-specific markdown files in this folder remain useful when they - match the area you are changing. +- `orca-cli-focused-v1-status.md` + - What is actually implemented and intentionally in scope now. +- `orca-cli-v1-spec.md` + - The public CLI contract, selector grammar, JSON envelope, and command semantics. +- `orca-runtime-layer-design.md` + - Why the runtime layer exists and which boundaries it owns. +- `orca-cli-bundled-distribution.md` + - How the bundled desktop-app distribution and PATH registration model works. -## Why The Folder Changes +## Why The Folder Is Small Earlier design and implementation work produced several planning and evaluation docs. Those were useful while the feature was taking shape, but they were intentionally removed diff --git a/skills/orca-cli/SKILL.md b/skills/orca-cli/SKILL.md index 1e9cfd677..c9d51287e 100644 --- a/skills/orca-cli/SKILL.md +++ b/skills/orca-cli/SKILL.md @@ -563,4 +563,8 @@ When `orca tab create` opens a new tab, it is automatically set as the active ta ## References -When behavior is unclear, refer to the design docs in `docs/` relevant to the feature area. +See these docs in this repo when behavior is unclear: + +- `docs/orca-cli-focused-v1-status.md` +- `docs/orca-cli-v1-spec.md` +- `docs/orca-runtime-layer-design.md`