docs: trim getting-started docs ~3x per internal audit#3249
Open
seanmartinsmith wants to merge 1 commit intogastownhall:mainfrom
Open
docs: trim getting-started docs ~3x per internal audit#3249seanmartinsmith wants to merge 1 commit intogastownhall:mainfrom
seanmartinsmith wants to merge 1 commit intogastownhall:mainfrom
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
seanmartinsmith
force-pushed
the
fix/3245-trim-getting-started
branch
from
5b9722a to
afb9a92
Compare
Apply findings from docs/GETTING_STARTED_ANALYSIS.md: - installation.md (261->81): Remove IDE section (duplicates ide-setup.md), remove updating section (duplicates upgrading.md), consolidate platforms, move CGO/build deps below happy path - quickstart.md (370->115): Remove Notion sync, database maintenance, database migration, database location sections. Trim role config and init options. Keep core flow: init, create, deps, ready, work, sync - ide-setup.md (204->80): Remove bd prime internals, trim MCP duplication, condense per-editor sections to command + verify pattern - upgrading.md (135->39): Consolidate table with detailed sections, trim troubleshooting to essentials Total: 970 lines -> 315 lines (3.1x reduction) Closes gastownhall#3245
seanmartinsmith
force-pushed
the
fix/3245-trim-getting-started
branch
from
afb9a92 to
9db6926
Compare
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
2 participants
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.
Problem
docs/GETTING_STARTED_ANALYSIS.md(by @csells, 2026-04-05) found the getting-started docs are ~3x longer than needed. The analysis identified four categories: genuinely necessary content (~25%), useful reference (~22%), workarounds for fixable UX issues (~28%), and redundancy across files (~25%). The doc-only recommendations were never acted on.Fix
Applied the doc-change recommendations from the analysis. No tool changes - just trimming, consolidating, and relocating content that belongs elsewhere.
Content removed from quickstart (Notion sync, db maintenance, db migration) belongs in integration docs and reference docs respectively - not in getting-started material.
Test Plan
/getting-started/references)Context
Closes #3245. Applies the "Immediate wins (doc changes only)" section from
docs/GETTING_STARTED_ANALYSIS.md. The analysis also recommends tool-level fixes (better error messages, auto-clear circuit breaker, etc.) that would eliminate even more doc surface area - those are separate issues.