docs: replace mkdocs-macros-plugin #263
Merged
Conversation
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
📝 WalkthroughWalkthroughRelease and documentation updates: Makefile release workflow fixed and changed to perform platform-specific in-place edits (macOS vs others) and moved version-replacement earlier; multiple docs and examples had version placeholders replaced with v0.6.2; mkdocs macros configuration and plugin removed; Dockerfile no longer installs mkdocs-macros-plugin. Changes
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@Makefile`:
- Around line 284-288: The Makefile's sed lines use the non-recursive glob
docs/**/*.md which /bin/sh doesn't expand; replace that glob with a find-based
invocation so files in nested dirs are processed. Update the two sed branches
(the Darwin branch invoking sed -i '' and the else branch invoking sed -i) to
run find docs -type f -name '*.md' and pass each matched file to sed (e.g. via
find ... -exec or find ... -print0 | xargs -0) so the replacement of $(shell
$(changie) latest) with $(VERSION) reliably touches all docs; keep the existing
sed dialect difference between the Darwin (BSD sed -i '') and non-Darwin (GNU
sed -i) branches and reuse the same replacement string referencing VERSION and
changie.
🧹 Nitpick comments (1)
docs/Dockerfile (1)
3-3: Pin doc plugin versions for reproducible builds.Unpinned installs can introduce breakage over time; consider a constraints/requirements file or explicit version pins.
mmols
approved these changes
Feb 6, 2026
Replaces the mkdocs-macros-plugin with a find-and-replace in the release process. When you run `make <major|minor|patch>-release`, we will now replace all occurrences of the current version in the docs with the new version. We must validate that these replacements are complete and correct in the release review PR. PLAT-405
jason-lynch
force-pushed
the
feat/PLAT-405/replace-mkdocs-macros-plugin
branch
from
e56242f to
e5f687d
Compare
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.
Summary
Replaces the mkdocs-macros-plugin with a find-and-replace in the release process. When you run
make <major|minor|patch>-release, we will now replace all occurrences of the current version in the docs with the new version. We must validate that these replacements are complete and correct in the release review PR.Changes
mkdocs-macros-pluginTesting
You can see what the release process changes will do by running:
If you were to run this release target without
--dry-run, these are the replacements it would make (I've prefixed all fences with#to preserve markdown formatting):You can try this for yourself, but please answer "N" to the prompt to avoid creating a real release. If you do this, you can return to your previous state by doing:
PLAT-405