Repository navigation
docs: add the Markdown user guide - #10714
Merged
Merged
Conversation
2 of 5 tasks
paulbalandan
force-pushed
the
docs-md-1-content
branch
from
November 3, 2026 10:59
5041a09 to
8ed9a2e
Compare
michalsn
approved these changes
Nov 3, 2026
This was referenced Nov 3, 2026
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.
Description
Part 1 of the user guide migration agreed in #10683. This PR only adds
docs/, the user guide converted fromuser_guide_src/sourcewith codeigniter4/docs-update. Nothing builds or deploys it yet, and the RST guide is unchanged.The user guide is frozen from this PR until the switch (PR 4 below) is merged. Please do not merge changes to
user_guide_srcin the meantime.If you have an open PR that changes RST, convert its pages after the cutover with docs-update (
make convert PAGE=libraries/email) and apply your edits to the Markdown indocs/.Planned PRs:
user_guide_src, changes the deployment and adds thecodeigniter4/userguidepackage files.The converter's checks compare the RST and the Markdown on every run. All pass for this branch: 325 pages, 485 PHP signatures, 1,958 code samples, 841 admonitions and no leftover RST markup. The strict MkDocs build is clean.
The pages are generated, so a review of
docs/index.mdand a few pages is enough.Checklist: