docs: normalize prose to one paragraph per line - #2951
Open
joseindie wants to merge 1 commit into
Open
Conversation
Reflow hard-wrapped paragraphs (80-110 col manual breaks) into single-line paragraphs across the four core prose docs. Strictly whitespace-only: every paragraph's text is identical after collapsing whitespace. Code blocks, tables, headings, list items, and raw HTML untouched. Motivation: mixed wrapping renders inconsistently in note tools that show single newlines as visible breaks (Obsidian et al) and complicates copy-paste. One-paragraph-per-line keeps future diffs readable.
Confidence Score: 5/5The PR appears safe to merge because it only normalizes prose layout and introduces no actionable behavioral or documentation defect. The changed files retain the same wording, Markdown structure, operational requirements, and alignment with VISION.md. Reviews (1): Last reviewed commit: "docs: normalize prose to one paragraph p..." | Re-trigger Greptile |
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
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.
What
Reflows hard-wrapped paragraphs (manual breaks at ~80-110 columns) into single-line paragraphs across the four core prose docs:
README.mdAGENTS.mdVISION.mddocs/architecture.mdStrictly whitespace-only — verified mechanically: collapsing all whitespace in before/after produces byte-identical text for every file. Code blocks, tables, headings, list items, and raw HTML (badges) are untouched.
Why
The docs currently mix one-sentence-per-line, wrapped-at-100-col, and full-paragraph styles. The 100-column wraps render as visible mid-sentence breaks in editors and note tools that display single newlines literally (Obsidian and similar), and they complicate copy-pasting prose elsewhere. One paragraph per line is already the style of several sections in these files; this makes it consistent and keeps future diffs readable (a sentence edit touches its paragraph line only).
Scope note
Limited to the four core docs to keep review tractable; happy to extend the same normalization to
docs/*.mdin a follow-up if this direction is welcome.