Skip to content

Conversation

@salihozkara
Copy link
Member

Fixes

Resolves https://github.com/volosoft/vs-internal/issues/7279

Summary

This PR adds SEO metadata support for documentation pages through a special comment syntax in Markdown files.

Changes

  • Added SEO metadata parser that extracts metadata from //[doc-seo] comment blocks in documentation files
  • Implemented support for custom Description meta tag
  • Metadata is defined in JSON format within the comment block

Usage

Documentation authors can now add SEO metadata at the beginning of their Markdown files using the following syntax:

```json
//[doc-seo]
{
    "Description": "Custom page description for SEO"
}
```

The parser will extract this metadata and apply it to the page's meta tags, improving search engine visibility and social media sharing.

Introduces support for extracting SEO metadata from document content by adding a new DocumentSeoDto, updating renderers to handle a new [doc-seo] section, and exposing this data in the project document page. The page now uses the SEO description if available, improving meta tag generation. Also adds error handling for scrollspy initialization in vs.js.
@gizemmutukurt gizemmutukurt merged commit 9502357 into dev Oct 14, 2025
3 checks passed
@gizemmutukurt gizemmutukurt deleted the issue-7279 branch October 14, 2025 11:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants