Full Documentation Catalog¶
This is the complete map of Orca's supporting documentation. For the product path, start with Orca Mission Control, then use this catalog only when you need a deeper workflow or policy reference.
The published version is available at:
https://henryvn27.github.io/orca-framework/
Start Here¶
- index.md: Orca Mission Control product home
- first-10-minutes.md: the fastest executable proof
- start-here.md: the product boundary and first path
- intro-guide.md: the shortest explanation of the ORCA approach
- first-workflow.md: one complete evidence-backed Mission
- demo.md: the Mission Control completion-gate demo
- quickstart.md: shortest path to installing and trying Orca
- install-overview.md: how the install system is organized
- install.md: canonical step-by-step install guide
- auto-updates.md: how ORCA checks, verifies, applies, and recovers updates
- readme-scope.md: what the top-level README should and should not do
- intro.md: the core mental model and why ORCA exists
- choose-your-path.md: route by use case instead of by file name
- graph-and-vault-support.md: optional vault and graph intelligence support
- corpus-overview.md: optional persistent corpus and reusable vault support
- adaptive-learning.md: lightweight learning help that adapts to the user
- side-sessions.md: portable side-chat,
/btw, and popout-thread rules across harnesses - explanation-mode.md: dedicated explain sessions, side-thread rules, and explain-state learning
- self-improvement.md: the controlled local-vs-framework learning model
- agent-orchestration.md: harness-agnostic parent and subagent orchestration
- deploy/vercel-guardrails.md: low-ceremony Vercel deploy rules and recurring pitfalls
Core Navigation¶
- information-architecture.md: how the docs are organized and why
- feature-index.md: what capabilities exist
- command-index.md: which command to use
- wrapped-capability-packs.md: how ORCA officially wraps maintained upstream packs such as Impeccable and Superpowers
- readme-feature-weighting.md: how README space should map to project importance
- use-case-map.md: which workflow fits which situation
- glossary.md: plain-language definitions for core terms
- concept-map.md: how the main framework pieces connect
- truth-hierarchy.md: which evidence should outrank generic advice
- source-of-truth-policy.md: how README and workflow positioning should follow live evidence
- vault-derived-positioning.md: what the current vault evidence implies about ORCA framing
- framework-differentiation.md: how to explain ORCA without slipping into generic category language
- friction-reduction-principle.md: the framework-wide rule for what should surface
- framework-principles.md: the small set of rules ORCA should follow everywhere
- escalation-policy.md: when ORCA should keep working vs ask the user to decide
- corpus-precedence.md: how global and project corpus settings resolve conflicts
Guides¶
These are teaching-oriented pages for common paths:
- guides/beginners-guide.md
- guides/from-gstack-or-gsd-to-orca-framework.md
- guides/goal-mode-guide.md
- guides/background-mode-guide.md
- guides/business-ideation-guide.md
- guides/graphify-guide.md
- guides/paved-roads-guide.md
- guides/runtime-adaptation-guide.md
- guides/visual-quality-guide.md
Deeper Reference¶
- commands.md
- skills.md
- workflow.md
- version-control.md
- install.md
- auto-updates.md
- compatibility-matrix.md
- linear-workflow.md
- corpus-settings.md
- corpus-writeback.md
- corpus-privacy.md
Contributor And Maintenance Docs¶
- contributing-docs.md
- readme-guardrails.md
- readme-review.md
- docs-automation.md
- wiki-maintenance.md
- staleness-detection.md
- doc-owners.md
- whats-new.md
- recent-doc-updates.md
- visual-quality.md
- human-voice.md
- token-efficiency.md
- orca-monitor-status.md
- integrations-overview.md
- integration-recommendation-policy.md
- optional-tooling-policy.md
- minimum-friction-policy.md
- adaptive-learning.md
- self-improvement.md
- instance-improvement-loop.md
- framework-improvement-loop.md
- user-skill-model.md
- learning-feedback-controls.md
- constructive-feedback-style.md
- prompting-coach.md
- agent-orchestration.md
- harness-agnostic-orchestration.md
- orchestration-patterns.md
- when-to-use-subagents.md
- context-passing.md
- feature-visibility-tiers.md
- feature-gate-friction-check.md
- feedback-tone-check.md
- graph-fit-rules.md
- graph-analysis-output-modes.md
- choose-your-stack.md
- session-improvement-loop.md
- session-quality-signals.md
- improvement-backlog.md
GitHub Wiki¶
The GitHub wiki is disabled for this repository. Keep public docs in docs/ so links, review, and CI validation stay in one tracked tree.