docs: join mid-sentence line breaks in docs/book for GitBook rendering#5109
Open
shivamsingh-007 wants to merge 2 commits into
Open
docs: join mid-sentence line breaks in docs/book for GitBook rendering#5109shivamsingh-007 wants to merge 2 commits into
shivamsingh-007 wants to merge 2 commits into
Conversation
Joins prose text that was broken mid-sentence across multiple lines, which GitBook renders as separate paragraphs with inconsistent spacing. Only joins within paragraphs and list-item continuations — never inside fenced code blocks, headings, tables, or other structural elements. Closes zenml-io#4084
The join script incorrectly joined:
- Closing ` with {% endtab %} (4 files)
- List item text with opening `�ash/python/yaml (3 files)
- @step decorator with def inside <pre> block (1 file)
All are now properly separated.
|
|
bcdurak
self-requested a review
July 23, 2026 13:13
bcdurak
added
documentation
Contributor
|
Hey @shivamsingh-007, thanks for the PR. I will take a look. |
Author
|
Thanks @bcdurak, appreciate you taking a look. Let me know if anything needs adjusting. |
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.
Joins mid-sentence line breaks in documentation files under \docs/book/\ for proper GitBook rendering. The join is markdown-aware: it preserves fenced code blocks, headings, tables, YAML frontmatter, hint blocks, and list structure.
Fixes #4084
What changed
245 markdown files in docs/book/ — prose paragraphs and list continuations with mid-sentence line breaks are now joined into single lines.
Why this approach
A custom Python script (not committed in the PR) was used to identify and join mid-sentence breaks. The logic is conservative: only joins a line to the next when the current line lacks sentence-ending punctuation AND the next starts with a lowercase letter (prose continuation). This avoids joining sentences.
Testing done