Skip to content

docs: normalize prose to one paragraph per line - #2951

Open
joseindie wants to merge 1 commit into
kunchenguid:mainfrom
joseindie:docs-upstream-pr
Open

docs: normalize prose to one paragraph per line#2951
joseindie wants to merge 1 commit into
kunchenguid:mainfrom
joseindie:docs-upstream-pr

Conversation

@joseindie

Copy link
Copy Markdown

What

Reflows hard-wrapped paragraphs (manual breaks at ~80-110 columns) into single-line paragraphs across the four core prose docs:

  • README.md
  • AGENTS.md
  • VISION.md
  • docs/architecture.md

Strictly 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/*.md in a follow-up if this direction is welcome.

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.
@greptile-apps

greptile-apps Bot commented Aug 24, 2026

Copy link
Copy Markdown

Confidence Score: 5/5

The 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant