Skip to content

Enhance SEO, search, and UI with metadata and view transitions#40

Merged
amavashev merged 10 commits intomainfrom
claude/explore-vitepress-improvements-58FIH
Mar 16, 2026
Merged

Enhance SEO, search, and UI with metadata and view transitions#40
amavashev merged 10 commits intomainfrom
claude/explore-vitepress-improvements-58FIH

Conversation

@amavashev
Copy link
Contributor

Summary

This PR improves the documentation site's search engine optimization, search functionality, and user experience through metadata additions, enhanced search configuration, and smooth page transitions.

Key Changes

  • SEO Enhancements: Added Open Graph and Twitter Card meta tags to improve social media sharing and search engine indexing
  • Sitemap Configuration: Added sitemap configuration with the canonical hostname for better search engine crawling
  • Search Improvements: Enhanced local search with detailed view, fuzzy matching (0.2 threshold), and prefix search enabled
  • Footer Addition: Added copyright and license information footer to all pages
  • View Transitions: Implemented View Transition API for smooth animated page transitions when navigating between routes
  • Hero Image: Added logo image to the homepage hero section for better visual presentation

Implementation Details

  • The View Transition API integration uses Vue's onMounted and watch hooks to detect route changes and trigger transitions
  • Search configuration uses miniSearch options to enable fuzzy matching with a 0.2 threshold and prefix-based search
  • Meta tags include og:type, og:title, og:description, og:image, og:url, and twitter:card for comprehensive social sharing support
  • Footer message and copyright are configurable through the theme config

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x

claude added 10 commits March 16, 2026 11:16
- Add custom CSS with brand colors (teal) matching logo and hero name gradient
- Add hero image (128px logo) to home page
- Add OG meta tags and Twitter card for social sharing
- Add sitemap generation (runcycles.io)
- Add site footer with license and copyright
- Enhance local search with detailed view, fuzzy matching, and prefix search
- Add smooth view transitions between pages

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
Logo design and brand colors are not finalized yet. Keep structural
improvements (footer, sitemap, OG tags, search, view transitions).

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
- Fix "RunCyles" -> "RunCycles" typo in nav and sidebar (2 instances)
- Add robots.txt pointing to sitemap
- Enable cleanUrls to remove .html from URLs
- Enable image lazy loading for performance

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
Add title and description frontmatter to all 5 concepts markdown files
for better search engine indexing and social sharing.

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
Add title and description frontmatter to all 10 quickstart markdown
files for better search engine indexing and social sharing.

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
Add title and description frontmatter to markdown files processed so
far. More files still being updated by background agents.

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
Add title and description frontmatter to remaining 26 markdown files:
16 protocol, 5 configuration, 4 incidents, 1 changelog.

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
Add title and description frontmatter to 14 more how-to markdown files.

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
- Add README.md to srcExclude so it doesn't appear in sitemap
- Set lang to 'en' and titleTemplate for consistent page titles
- Add SEO descriptions to API and Admin API index pages

https://claude.ai/code/session_019vFxE97hU7VkJ7tG8cXD6x
@amavashev amavashev merged commit 0499e93 into main Mar 16, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants