docs: add versioning with mike#1334
Open
michalsn wants to merge 2 commits into
Open
Conversation
michalsn
force-pushed
the
feat/docs-versioning
branch
from
57205ec to
2381374
Compare
datamweb
reviewed
Jun 3, 2026
Collaborator
datamweb
left a comment
datamweb
left a comment
There was a problem hiding this comment.
If possible, could you please update this file as well?
https://github.com/codeigniter4/shield/blob/develop/admin/how_to_build_docs.md
Collaborator
There was a problem hiding this comment.
I’ve actually used mike in a previous project, but I don’t recall any requirement to delete CNAME. Could you clarify why it was removed?
Member
Author
There was a problem hiding this comment.
Since each version of the docs lives in its own subfolder, the CNAME file would be placed there instead of in the root.
File how_to_build_docs.md is now updated.
datamweb
reviewed
Jun 4, 2026
Collaborator
datamweb
left a comment
datamweb
left a comment
There was a problem hiding this comment.
Could you please rebase this PR to resolve the conflicts?
michalsn
force-pushed
the
feat/docs-versioning
branch
from
4bc5e1f to
c88de7f
Compare
datamweb
approved these changes
Jun 4, 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
2 participants
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
This PR adds docs versioning using mike, published to the
gh-pagesbranch.Deploy rules
develop: deploys thedevdocs (work-in-progress)vX.Y.Ztag (e.g.v1.4.0): deploys docs under<major>.<minor>(e.g.1.4), updates thelatestalias, and sets it as the default version (site root redirects here)v1.4.0-rc1): are skippedChecklist: