docs: tighten AI-read docs and drop redundant comments - #24
Closed
ohing504 wants to merge 1 commit into
Closed
Conversation
Restructure wall-of-text paragraphs that packed several concerns into one run-on block, and remove comments that only restate adjacent code, so the docs and comments scan faster for both agents and humans. - architecture.md: split the sizing paragraph into labeled disk/apparent figures, hard-link/symlink invariants, and the shared sizing pool; lead with "disk is the primary figure" instead of burying it. - ecosystems.md: turn the excluded-config-roots and Browser Temp paragraphs into a lead plus a path→reason table / labeled bullets so the safety and scope rules are not lost mid-sentence. - Drop three comments that restate the next line (`// Sort`, `// Set project root to git root`) or leak an internal label. No content removed — the restructures preserve every path, reason, and observed figure. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01YSTf3ozF4SnboZHyEi7Ycc
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
1 participant
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.
Tightens the AI-read SSOT docs for token density and scannability, plus a few comment cleanups. Format-only — no path, reason, or figure was dropped.
Changes
architecture.md — the sizing section was one paragraph packing six concerns (progress labels, disk/apparent figures, directory blocks, hard-link dedup, symlink policy, deferred parallel sizing). Split into:
sizePendingpool as a single closing statement.ecosystems.md
path → whytable (every excluded path and reason preserved).Comments — removed three that restate the next line or leak an internal label:
internal/cli/scan.go// Sortinternal/classifier/git.go// Set project root to git rootinternal/output/output_test.go— the point of A1Not included (needs your call)
The doc audit flagged several cross-file duplications (vendor-cleanup rationale, clean-flow keybindings, safety-model legend, dedup mechanism) shared across
commands.md/ecosystems.md/architecture.md/CLAUDE.md. Resolving them means moving content (pick one canonical home + pointer), which is a judgment call — left out of this autonomous pass.Verified
go build·go vet·go test ./...·golangci-lint runall pass.🤖 Generated with Claude Code
https://claude.ai/code/session_01YSTf3ozF4SnboZHyEi7Ycc