Fix canonical URLs to use direct page paths #4165
Open
+18
−27
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
|
can you share the exact testing steps/validations/screenshots that you tested? |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation generator to fix canonical URL formatting for better search engine indexing. The change moves from query parameter-based URLs (index.html?page=X&tocid=Y) to direct path URLs (items/S3/TS3Client.html), while preserving frameset redirect functionality through a new meta tag.
Key Changes
- Canonical URLs now point directly to documentation pages instead of frameset with query parameters
- Added
<meta name="aws-tocid">tag to store the table of contents ID needed for redirect logic - Updated JavaScript redirect logic to read tocid from meta tag instead of parsing canonical URL
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docgenerator/SDKDocGeneratorLib/Writers/BaseWriter.cs | Updated canonical URL format to use direct paths and added aws-tocid meta tag |
| docgenerator/SDKDocGeneratorLib/output-files/resources/parentloader.js | Modified frameset redirect logic to read tocid from meta tag and construct URL from current pathname |
peterrsongg
reviewed
Dec 10, 2025
| } | ||
| //Else do nothing because the link doesn't appear to be in a normal URL format where the | ||
| //hostname ends with a / starting the relative URL path. | ||
| if (tocid && itemsIndex !== -1) { |
Contributor
There was a problem hiding this comment.
so what happens if we don't get into this if statement? we dont set the window.location.href? Is that ever a valid case?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
index.html?page=X&tocid=Yto direct paths likeitems/S3/TS3Client.html<meta name="aws-tocid">for redirect logicMotivation and Context
Canonical URLs pointed to frameset with query params. Search engines saw mismatch between canonical and actual page URL, hurting indexing.
Testing
Types of changes
Checklist
License