Reformats the docs to improve readability - #2226
Merged
Merged
Conversation
Goooler
force-pushed
the
g/20260824/docs
branch
2 times, most recently
from
August 24, 2026 05:33
ccf7ff1 to
374f5a9
Compare
Goooler
force-pushed
the
g/20260824/docs
branch
from
August 24, 2026 05:41
374f5a9 to
c63f1c4
Compare
Goooler
force-pushed
the
g/20260824/docs
branch
from
August 24, 2026 12:43
5d741d5 to
50a0006
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR reformats the project documentation to improve readability (line wrapping / paragraph flow) and adjusts MkDocs configuration to render lists consistently across the site.
Changes:
- Reflow and wrap text across README and MkDocs docs pages; normalize list formatting.
- Enable
mdx_truly_sane_listsin MkDocs and install it in CI/docs workflows to improve nested list rendering. - Minor formatting-only updates to embedded SVG sources.
Reviewed changes
Copilot reviewed 22 out of 24 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Reflow NOTE block and recommendation paragraph for better wrapping. |
| mkdocs.yml | Adds mdx_truly_sane_lists extension configuration for improved list handling. |
| docs/README.md | Reflows intro and sections; adjusts warning block formatting and paragraphs. |
| docs/publishing/README.md | Reflows paragraphs for publishing docs; reduces excessive blank/indented lines. |
| docs/multi-project/README.md | Reflows paragraphs and important-note formatting; removes trailing blank block lines. |
| docs/kotlin-plugins/README.md | Reflows paragraphs and removes trailing blank block line. |
| docs/images/logo+type.orig.svg | Formatting-only SVG normalization (e.g., hex casing). |
| docs/images/logo.orig.svg | Formatting-only SVG normalization (e.g., hex casing). |
| docs/getting-started/README.md | Reflows paragraphs; converts task list bullets and nested list indentation. |
| docs/custom-tasks/README.md | Reflows paragraphs and removes trailing blank block line. |
| docs/configuration/reproducible-builds/README.md | Removes trailing blank block line. |
| docs/configuration/relocation/README.md | Reflows paragraphs; adjusts warning block line wrapping. |
| docs/configuration/README.md | Reflows paragraphs and fixes minor spacing around a link reference. |
| docs/configuration/minimizing/README.md | Reflows paragraphs and consolidates line wrapping. |
| docs/configuration/merging/README.md | Rewraps long lines and restructures nested list indentation. |
| docs/configuration/filtering/README.md | Reflows paragraphs and removes trailing blank block line. |
| docs/configuration/dependencies/README.md | Reflows paragraphs; adjusts admonition text wrapping. |
| docs/changes/README.md | Reflows changelog content and normalizes list indentation/formatting. |
| docs/application-plugin/README.md | Reflows paragraphs and removes trailing blank block line. |
| docs/android-plugins/README.md | Removes trailing blank block line. |
| docs/about/README.md | Reflows paragraphs; converts maintainer list to - bullets. |
| CONTRIBUTING.md | Updates MkDocs install command to include mdx_truly_sane_lists. |
| .github/workflows/links.yml | Installs mdx_truly_sane_lists during MkDocs build validation. |
| .github/workflows/deploy.yml | Installs mdx_truly_sane_lists during site build prior to deploy. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
No description provided.