Skip to content

Reformats the docs to improve readability - #2226

Merged
Goooler merged 11 commits into
mainfrom
g/20260824/docs
Aug 24, 2026
Merged

Reformats the docs to improve readability#2226
Goooler merged 11 commits into
mainfrom
g/20260824/docs

Conversation

@Goooler

@Goooler Goooler commented Aug 24, 2026

Copy link
Copy Markdown
Member

No description provided.

@Goooler
Goooler force-pushed the g/20260824/docs branch 2 times, most recently from ccf7ff1 to 374f5a9 Compare August 24, 2026 05:33
@Goooler
Goooler requested a lite review from Copilot August 24, 2026 12:49

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_lists in 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.

Comment thread docs/changes/README.md
@Goooler Goooler changed the title Wrap long lines in documentation Reformats the docs to improve readability Aug 24, 2026
@Goooler
Goooler merged commit 2d67286 into main Aug 24, 2026
5 checks passed
@Goooler
Goooler deleted the g/20260824/docs branch August 24, 2026 12:56
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.

2 participants