fix(docs): resolve SEO issues in documentation#250
Merged
Conversation
- Fix titleTemplate: use `:title` placeholder instead of `%s` (VitePress v1.6.4) - Add `titleTemplate: false` to home page to avoid "GitLab MCP | GitLab MCP" - Enable `cleanUrls: true` to remove `.html` from URLs and sitemap - Add `<link rel="canonical">` via transformHead for all pages - Add `lastmod` to sitemap entries via transformItems - Add `<meta name="keywords">` to all 72 documentation pages - Add `/TOOLS` pattern to ignoreDeadLinks (generated file may not exist at build time) Closes #249
There was a problem hiding this comment.
Pull request overview
This PR resolves multiple SEO issues in the VitePress documentation site by updating configuration and adding metadata to all documentation pages.
Changes:
- Fixed
titleTemplatesyntax for VitePress v1.6.4+ compatibility (changed from%sto:title) - Enabled clean URLs, added canonical links, and sitemap lastmod dates
- Added SEO-optimized keywords meta tags to all 72 documentation pages
Reviewed changes
Copilot reviewed 72 out of 72 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/.vitepress/config.mts | Updated titleTemplate syntax, enabled cleanUrls, added canonical links via transformHead, added lastmod to sitemap entries, added /TOOLS pattern to ignoreDeadLinks |
| docs/index.md.in | Added titleTemplate: false to prevent duplication, added keywords meta tag |
| docs/troubleshooting/*.md | Added keywords meta tags for troubleshooting pages |
| docs/tools/*.md | Added keywords meta tags for tool reference pages |
| docs/sponsor.md | Added keywords meta tag for sponsor page |
| docs/setup-github-secrets.md | Added keywords meta tag for GitHub secrets setup |
| docs/security/*.md | Added keywords meta tags for security pages |
| docs/prompts/**/*.md | Added keywords meta tags for all prompt library pages |
| docs/guides/*.md | Added keywords meta tags for all guide pages |
| docs/guide/**/*.md | Added keywords meta tags for all getting started and installation pages |
| docs/deployment/*.md | Added keywords meta tags for all deployment pages |
| docs/clients/*.md | Added keywords meta tags for all client setup pages |
| docs/cli/*.md | Added keywords meta tags for all CLI reference pages |
| docs/advanced/*.md | Added keywords meta tags for advanced configuration pages |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
sw-release-bot bot
pushed a commit
that referenced
this pull request
Feb 2, 2026
## [6.51.0](v6.50.0...v6.51.0) (2026-02-02) ### Features * **docs:** consent banner + vue-privacy 1.2.2 with gtag fix ([#255](#255)) ([75eb54b](75eb54b)) ### Bug Fixes * **ci:** prevent transitive skip propagation in release pipeline ([#266](#266)) ([f809a7a](f809a7a)), closes [#264](#264) [#265](#265) [#265](#265) * **ci:** replace heredoc with quoted strings in thread-gate job ([#246](#246)) ([9470b50](9470b50)), closes [#243](#243) [#245](#245) * **ci:** unblock release pipeline on push to main ([#264](#264)) ([59b8cbe](59b8cbe)), closes [#263](#263) * **deps:** update hono from 4.11.5 to 4.11.7 ([#248](#248)) ([71cc831](71cc831)), closes [#247](#247) * **docs:** resolve SEO issues in VitePress documentation ([#249](#249)) ([#250](#250)) ([3e05717](3e05717)) * **docs:** use canonical URL for TOOLS reference in README ([#252](#252)) ([5ac56cc](5ac56cc)), closes [#251](#251) * **pipelines:** serialize array query params as key[] for GitLab Rails API ([#262](#262)) ([955a3c1](955a3c1)), closes [#261](#261)
|
🎉 This PR is included in version 6.51.0 🎉 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
titleTemplate: use:titleplaceholder instead of%s(VitePress v1.6.4)titleTemplate: falseto home page to prevent "GitLab MCP | GitLab MCP"cleanUrls: true— remove.htmlfrom all URLs and sitemap entries<link rel="canonical">viatransformHeadfor all pageslastmodto sitemap entries viatransformItems<meta name="keywords">to all 72 documentation pages (.md and .md.in)/TOOLSpattern toignoreDeadLinks(generated file may not exist at build time)Test plan
DOCS_BASE=/ npx vitepress build docs— builds successfully%sin<title>tagsGitLab MCP(notGitLab MCP | GitLab MCP)lastmodon all entries, no.htmlin URLsCloses #249