Skip to content

docs: remove redundant implementation walkthroughs - #807

Merged
hakula139 merged 4 commits into
mainfrom
docs/remove-redundant-detail
Nov 1, 2026
Merged

hakula139 merged 4 commits into
mainfrom
docs/remove-redundant-detail

Conversation

@hakula139

@hakula139 hakula139 commented Nov 1, 2026 •

Copy link
Copy Markdown
Owner

Summary

The design pages repeat code-level details, and Quickstart repeats the tool catalog. The architecture page now explains ownership and execution flow with links to detailed designs.

  • Design: replace the module inventory with crate and layer responsibilities. Remove field and parser walkthroughs, layout mechanics, and spill filename rules while retaining lifecycle and failure contracts.
  • Guides: remove generic prompting advice and the tool catalog, retain approvals and background-shell instructions, and correct the saved-output size limit.

Test plan

  • pnpm format, pnpm lint, pnpm spellcheck, and commit hooks pass.
  • All 12 architecture links resolve. Renamed Quickstart references use the current anchor.
  • Read the complete architecture page against its linked designs and source boundaries.
  • Rust checks were not repeated for the final documentation-only correction.

@hakula139 hakula139 added the documentation Changes confined to README, docs/, or other documentation (docs) label Nov 1, 2026
@hakula139 hakula139 self-assigned this Nov 1, 2026
@hakula139 hakula139 added this to the v0.1.0-alpha.10 milestone Nov 1, 2026
@codecov

codecov Bot commented Nov 1, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@hakula139
hakula139 force-pushed the docs/remove-redundant-detail branch from 59d8a63 to 12384db Compare November 1, 2026 11:15
Replace the module inventory with crate and layer responsibilities, service boundaries, and the shared engine flow. Keep navigation to detailed designs and correct the saved-output size claim.
@hakula139
hakula139 merged commit b2af1b8 into main Nov 1, 2026
9 checks passed
@hakula139
hakula139 deleted the docs/remove-redundant-detail branch November 1, 2026 11:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Changes confined to README, docs/, or other documentation (docs)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant