Skip to content

docs: fix grammar, markup and line width across the user guide - #10709

Merged
paulbalandan merged 2 commits into
codeigniter4:developfrom
paulbalandan:user-guide-prose-sweep
Nov 3, 2026
Merged

paulbalandan merged 2 commits into
codeigniter4:developfrom
paulbalandan:user-guide-prose-sweep

Conversation

@paulbalandan

Copy link
Copy Markdown
Member

Description
Sweeps user_guide_src/source for language errors, RST problems that would block the Markdown migration, and line width.

  • Fixes grammar and awkward wording, and corrects statements that did not match the code.
  • Wraps unmarked code in double backticks and unmarked paths in double asterisks, and fixes broken RST constructs.
  • Wraps prose at 120 characters, in a separate commit that changes only line breaks. Changelogs, tables, literal blocks and field lists are not reflowed.
  • About 25 headings are retitled, so their anchors change.

make html has 0 warnings, the rendered pages are identical before and after the reflow, and the docs-update converter passes on all 325 pages.

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value (without duplication)
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@carson-codeigniter4 carson-codeigniter4 Bot added the documentation Pull requests for documentation only label Nov 3, 2026
@paulbalandan
paulbalandan merged commit e6c0d56 into codeigniter4:develop Nov 3, 2026
13 checks passed
@paulbalandan
paulbalandan deleted the user-guide-prose-sweep branch November 3, 2026 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests for documentation only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants