Add versions to API metadata & autogenerate index page metadata #2241
Conversation
This file contains 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
|
CI fails on this because pagesRender has too many changed files |
frankharkins
approved these changes
Nov 6, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
An issue with our API docs is confusing which version specific pages correspond to because we have so many duplicates. That is especially an issue with SEO, but also rich previews & tab titles. So, this PR adds the version to both the
titleanddescription.We use minor versions rather than patch versions because search engines can be slow to update and we don't want their metadata to be out-of-date. Likewise, we call it
(latest version)and(dev version)for this same reason.Finally, this PR automates setting metadata for the index page whereas before we hardcoded it.