great-docs seo

Audit SEO health of your documentation site.

great-docs seo [OPTIONS]

Checks for common SEO issues and provides recommendations for improvement. Run this after building your site with great-docs build.

• Checks performed:
• sitemap.xml presence and validity
• robots.txt presence and configuration
• Canonical URLs on all pages
• Meta descriptions on pages
• JSON-LD structured data
• Page titles with site name
• Missing alt text on images
• Broken internal links (basic check)

Full --help output

Usage: great-docs seo [OPTIONS]

  Audit SEO health of your documentation site.

  Checks for common SEO issues and provides recommendations for improvement.
  Run this after building your site with 'great-docs build'.

  Checks performed:
    • sitemap.xml presence and validity
    • robots.txt presence and configuration
    • Canonical URLs on all pages
    • Meta descriptions on pages
    • JSON-LD structured data
    • Page titles with site name
    • Missing alt text on images
    • Broken internal links (basic check)

  Examples:
    great-docs seo                        # Audit SEO health
    great-docs seo --fix                  # Fix issues where possible
    great-docs seo --json                 # JSON output for CI

Options:
  --project-path DIRECTORY  Path to your project root directory (default:
                            current directory)
  --fix                     Attempt to fix some issues automatically (e.g.,
                            generate missing files)
  --json                    Output results as JSON for CI integration
  --help                    Show this message and exit.

Options

--project-path: DIRECTORY

Path to your project root directory (default: current directory)

--fix

Attempt to fix some issues automatically (e.g., generate missing files)

--json

Output results as JSON for CI integration

Examples

  great-docs seo                        # Audit SEO health
  great-docs seo --fix                  # Fix issues where possible
  great-docs seo --json                 # JSON output for CI