docs: vendor the VitePress config; serve static assets from public/ - #497
Draft
lkdvos wants to merge 1 commit into
Draft
docs: vendor the VitePress config; serve static assets from public/#497lkdvos wants to merge 1 commit into
lkdvos wants to merge 1 commit into
Conversation
`MarkdownVitepress` does not expose `themeConfig.search` or `markdown.config`, so `docs/src/.vitepress/config.mts` is vendored from the DocumenterVitepress template with the MPSKit-specific hooks added on top. Since a vendored copy silently rots, `make.jl` checksums the upstream template and warns when it changes, naming the two template versions our copy is known to be a faithful superset of. VitePress serves files under `src/public/` verbatim at the site root, which is what the logo and favicon need; `src/assets/` is for files Documenter itself processes. Move them accordingly and add the landing-page feature icons alongside. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This was
linked to
issues
Aug 3, 2026
Contributor
|
After the build completes, the updated documentation will be available here |
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
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
1 participant
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.
Split out of #449 so it can be reviewed on its own; independent of the documentation content.
MarkdownVitepressdoes not exposethemeConfig.searchormarkdown.config, sodocs/src/.vitepress/config.mtsis vendored from the DocumenterVitepress template with the MPSKit hooks added on top. Since a vendored copy silently rots,make.jlchecksums the upstream template and warns when it changes, naming the versions our copy is a faithful superset of.The theme CSS carries the fixes for #477 and #478 (docstring heading rendering, library search) and restores admonition styling.
VitePress serves
src/public/verbatim at the site root, which is what the logo and favicon need;src/assets/is for files Documenter processes. Moved accordingly.🤖 Generated with Claude Code