Skip to content

docs: align public documentation structure#220

Merged
DeadWaveWave merged 1 commit intomainfrom
docs/public-docs-alignment
May 2, 2026
Merged

docs: align public documentation structure#220
DeadWaveWave merged 1 commit intomainfrom
docs/public-docs-alignment

Conversation

@DeadWaveWave
Copy link
Copy Markdown
Owner

@DeadWaveWave DeadWaveWave commented May 2, 2026

💡 Change Scope

  • Small Change: Fast feedback, localized UI/logic, low-risk.
  • Large Change: New feature, cross-boundary logic, runtime-risk (persistence, IPC, lifecycle, recovery).

📝 What Does This PR Do?

This PR aligns the public documentation with the current implementation state and reorganizes docs/ by topic.

  • Moves public docs into categorized directories such as docs/architecture, docs/cli, docs/canvas, docs/runtime, docs/ui, and docs/development.
  • Updates docs/README.md, root README links, CONTRIBUTING.md, and DEVELOPMENT.md to point at the new document locations.
  • Removes public draft/spec/plan documents and keeps docs/ limited to current public facts.
  • Adds/updates architecture docs for current workspace capability, control surface, persistence, recovery, CLI, canvas, terminal, UI, and debugging entry points.
  • Verifies public docs do not reference private docs or expose roadmap-style content beyond actual state.

🏗️ 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

  • My code passes the ultimate gatekeeper: pnpm pre-commit is completely green.
  • I have signed the CLA if required (see CLA.md).
  • I have included new tests to lock down the behavior (or explicitly stated why it's untestable). Docs-only change; no runtime tests added. Existing full gate was run.
  • I have strictly adhered to the DEVELOPMENT.md architectural boundaries.
  • I have attached a screenshot or screen recording (if this touches the UI). N/A: docs-only.
  • I have updated the documentation accordingly (if adding a feature or changing a contract).

📸 Screenshots / Visual Evidence

N/A: docs-only change.

Verification

  • pnpm pre-commit: passed, including E2E 210 passed, 45 skipped.
  • git diff --check --cached: passed.
  • Public docs stale-path scan: passed.
  • Public docs roadmap/private-doc leak scans: passed.
  • Markdown docs path existence check: passed.

@DeadWaveWave DeadWaveWave merged commit 689f67a into main May 2, 2026
7 checks passed
@DeadWaveWave DeadWaveWave deleted the docs/public-docs-alignment branch May 2, 2026 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant