Docs pass 2: tighter cuts across all four files (526 → 213 lines)#28
Merged
Conversation
REFACTOR_PLAYBOOK.md (261 → 55): - Decision tree (40 lines of ASCII art) → 8-row table - Verifiable-object consolidation 10-step procedure → 5 steps + sentence on automation - Each pitfall: one paragraph instead of 5-10 lines - Drop separators, sister-doc front matter SORRY_CATALOG.md (115 → 29): - Drop per-file tables — they duplicate the per-sorry docstring repair plans and drift fast (catalog claimed 32, CI says 42). - Keep classification definitions + per-module summary table. - Authoritative count lives in ci.yml; per-sorry repair plans live in each sorry's docstring; this file is now an at-a-glance summary only. NAMING_CONVENTION.md (91 → 84): - §1 prose tightened, "avoid these engineering suffixes" collapsed from 4-line bullet list to one sentence. CONVENTIONS.md (59 → 45): - Trim narrative padding, drop horizontal separators between sections, collapse a few multi-paragraph items into single paragraphs.
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.
Summary
Second cleanup pass on
docs/. After PR #27 cut 901 → 526, this further cuts to 213 (76% off original).Biggest cuts
REFACTOR_PLAYBOOK.md (261 → 55):
SORRY_CATALOG.md (115 → 29):
EXPECTED=42).EXPECTEDconstant; per-sorry repair plans in each sorry's docstring.Test plan
OpenGALib/references docs that were removed.