Skip to content

Improve documentation SEO with structured data (JSON-LD) #305

@polaz

Description

@polaz

Summary

Improve documentation site SEO according to Google guidelines for title links and structured data.

Changes

Structured Data (JSON-LD)

  • WebSite schema - Global schema on all pages with organization info
  • BreadcrumbList schema - Dynamic breadcrumbs based on URL path
  • SoftwareApplication schema - On home and installation pages
  • FAQPage schema - On troubleshooting pages (via frontmatter)
  • HowTo schema - On guide pages (via frontmatter)

Technical SEO

  • Add lang="en-US" attribute to HTML
  • Improve default meta description fallback
  • Add outline (table of contents) for H2-H3 headings

Files Modified

  • docs/.vitepress/config.mts - JSON-LD generation, lang, outline config
  • docs/troubleshooting/*.md - FAQ frontmatter
  • docs/guide/quick-start.md - HowTo frontmatter

Verification

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions