Skip to content

DOCS: Unwrap hard-wrapped paragraphs in GitBook documentation#4225

Merged
TomOnTime merged 4 commits intoDNSControl:mainfrom
cafferata:docs/unwrap-hard-wrapped-paragraphs
May 8, 2026
Merged

DOCS: Unwrap hard-wrapped paragraphs in GitBook documentation#4225
TomOnTime merged 4 commits intoDNSControl:mainfrom
cafferata:docs/unwrap-hard-wrapped-paragraphs

Conversation

@cafferata
Copy link
Copy Markdown
Member

@cafferata cafferata commented May 5, 2026

Reflow prose in 15 documentation pages so each paragraph is a single line instead of being hard-wrapped at ~70 characters. Hard-wrapped Markdown caused awkward soft-wrap rendering on docs.dnscontrol.org. Code blocks, front matter, lists, blockquotes, tables, HTML, and {% hint %} / {% code %} blocks are left untouched. No content changes.

Before

Screenshot 2026-05-05 at 08 31 55

https://docs.dnscontrol.org/getting-started/migrating

After

Screenshot 2026-05-05 at 08 43 08

https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/getting-started/migrating

Before (live) After (revisie)
https://docs.dnscontrol.org/getting-started/migrating https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/getting-started/migrating
https://docs.dnscontrol.org/provider/hetzner https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/provider/hetzner
https://docs.dnscontrol.org/advanced-features/code-tricks https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/advanced-features/code-tricks
https://docs.dnscontrol.org/advanced-features/concurrency-verified https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/advanced-features/concurrency-verified
https://docs.dnscontrol.org/advanced-features/opinions https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/advanced-features/opinions
https://docs.dnscontrol.org/advanced-features/testing-txt-records https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/advanced-features/testing-txt-records
https://docs.dnscontrol.org/advanced-features/json-reports https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/advanced-features/json-reports
https://docs.dnscontrol.org/commands/colors https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/commands/colors
https://docs.dnscontrol.org/commands/get-zones https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/commands/get-zones
https://docs.dnscontrol.org/commands/preview-push https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/commands/preview-push
https://docs.dnscontrol.org/language-reference/why-the-dot https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/language-reference/why-the-dot
https://docs.dnscontrol.org/language-reference/domain-modifiers/nameserver https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/language-reference/domain-modifiers/nameserver
https://docs.dnscontrol.org/language-reference/domain-modifiers/no_purge https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/language-reference/domain-modifiers/no_purge
https://docs.dnscontrol.org/language-reference/domain-modifiers/txt https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/language-reference/domain-modifiers/txt
https://docs.dnscontrol.org/language-reference/top-level-functions/d_extend https://docs.dnscontrol.org/~/revisions/Uy3v06HuP9Hvf4EPf9c7/language-reference/top-level-functions/d_extend

- Reflow prose in 15 documentation pages so each paragraph is a single line instead of being hard-wrapped at ~70 characters. Hard-wrapped Markdown caused awkward soft-wrap rendering on docs.dnscontrol.org. Code blocks, front matter, lists, blockquotes, tables, HTML, and {% hint %} / {% code %} blocks are left untouched. No content changes.
@cafferata cafferata force-pushed the docs/unwrap-hard-wrapped-paragraphs branch from d6f0f84 to 967169e Compare May 5, 2026 06:42
cafferata added 2 commits May 5, 2026 09:11
Round 2 of the reflow pass: catches 54 more files with hard-wrapped
paragraphs that were missed in the initial commit. GitBook {% hint %}
blocks, emoji-prefixed legend lines, nested list indentation, code
blocks, and front matter are preserved.
@TomOnTime
Copy link
Copy Markdown
Collaborator

I thought Markdown merged short lines and used a blank line to indicate a new paragraph. How disappointing! Diffs will be much larger. *shakes fist at clouds*

@TomOnTime TomOnTime merged commit e47eda9 into DNSControl:main May 8, 2026
12 checks passed
@cafferata cafferata deleted the docs/unwrap-hard-wrapped-paragraphs branch May 8, 2026 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

2 participants