Skip to content

Conversation

@AlexDaines
Copy link
Contributor

Add SEO meta tags and canonical URL to frameset page

Description

Added TCX-required SEO meta tags to the documentation frameset index.html:

  • <meta name="description"> - API reference description
  • <meta name="guide-name"> - Guide name for search indexing
  • <meta name="service-name"> - Service name for search indexing
  • <link rel="canonical"> - Canonical URL for SEO

These tags were added to docgenerator/SDKDocGeneratorLib/output-files/index.html (lines 8-11) after the Content-Type meta tag and before the stylesheet links.

Motivation and Context

TCX SEO requirements mandate these meta tags for proper search indexing and SEO optimization of AWS documentation pages. The frameset page (index.html) was missing these tags while other documentation pages already had them.

Testing

  • Built documentation generator: dotnet build - succeeded with 0 errors
  • Verified meta tags copied to build output directories
  • Confirmed all 4 tags present in generated index.html files
  • Verified correct tag order and content in SDKDocGeneratorLib/bin/Debug/netstandard2.0/output-files/index.html

Screenshots (if appropriate)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have read the README document
  • I have added tests to cover my changes
  • All new and existing tests passed

License

  • I confirm that this pull request can be released under the Apache 2 license

@AlexDaines AlexDaines requested a review from Copilot November 21, 2025 18:18
Copilot finished reviewing on behalf of AlexDaines November 21, 2025 18:21
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds TCX-required SEO meta tags to the documentation generator's frameset index.html template. These tags enable proper search indexing and SEO optimization for AWS documentation pages. The changes are documentation-only and do not affect SDK functionality, so no dev config file is required per CONTRIBUTING.md guidelines.

Key Changes

  • Added four SEO meta tags (description, guide-name, service-name, and canonical link) to the frameset HTML template
  • Tags follow existing patterns from other documentation HTML files like feedbackyes.html and MobileNavBar.html
  • Uses HTTPS protocol for the canonical URL, following modern web standards

@AlexDaines AlexDaines marked this pull request as ready for review November 25, 2025 20:55
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.

1 participant