docs: align public documentation structure#220
Merged
DeadWaveWave merged 1 commit intomainfrom May 2, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
💡 Change Scope
📝 What Does This PR Do?
This PR aligns the public documentation with the current implementation state and reorganizes
docs/by topic.docs/architecture,docs/cli,docs/canvas,docs/runtime,docs/ui, anddocs/development.docs/README.md, root README links,CONTRIBUTING.md, andDEVELOPMENT.mdto point at the new document locations.docs/limited to current public facts.🏗️ Large Change Spec (Required if "Large Change" is checked)
N/A. This is a docs-only reorganization and alignment change. It does not modify runtime behavior, persistence schema, IPC contracts, lifecycle code, or UI implementation.
1. Context & Business Logic
N/A.
2. State Ownership & Invariants
N/A. No application state ownership changes.
3. Verification Plan & Regression Layer
Validated through staged checks, full pre-commit, docs leak scans, stale path scans, and link existence checks.
✅ Delivery & Compliance Checklist
pnpm pre-commitis completely green.CLA.md).DEVELOPMENT.mdarchitectural boundaries.📸 Screenshots / Visual Evidence
N/A: docs-only change.
Verification
pnpm pre-commit: passed, including E2E210 passed, 45 skipped.git diff --check --cached: passed.