Conversation
…lates - Add editLink.pattern function to detect templated files and redirect to .md.in source - Add docs/clients/claude-desktop.md to .gitignore (missing for generated file) Closes #217
There was a problem hiding this comment.
Pull request overview
This PR fixes broken "Edit this page on GitHub" links for documentation pages that are generated from .md.in templates. VitePress was previously generating edit links pointing to non-existent .md files in the repository, resulting in 404 errors.
Changes:
- Modified VitePress
editLink.patternto use a function that detects templated files and redirects to their.md.insource files - Added missing
docs/clients/claude-desktop.mdto.gitignorefor consistency with other generated files
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/.vitepress/config.mts | Replaced static edit link pattern with a function that appends .in to paths for the 6 pages generated from .md.in templates |
| .gitignore | Added docs/clients/claude-desktop.md which was missing from the list of generated documentation files |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
polaz
deleted the
feat/#217-fixdocs-edit-links-point-to-404-for-generated-md-f
branch
|
🎉 This PR is included in version 6.47.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Summary
editLink.patternnow uses a function to detect templated files and redirect to.md.insourcedocs/clients/claude-desktop.mdto.gitignore(was missing for generated file)Affected Pages
All 6 pages generated from
.md.intemplates now link to correct source:/docs/index.md.in/guide/docs/guide/index.md.in/guide/authenticationdocs/guide/authentication.md.in/guide/installation/claude-desktopdocs/guide/installation/claude-desktop.md.in/tools/docs/tools/index.md.in/clients/claude-desktopdocs/clients/claude-desktop.md.inTest plan
yarn docs:dev.md.infiles that exist in repoCloses #217