Repository navigation
docs: the website and its docs describe each page to search engines - #1336
Merged
Merged
Conversation
Search engines and link previews had little to go on: the landing page's title was just "OpenReliant", without StarLancer in it, every docs page shared one description, the landing and contribute pages gave no canonical address, and no one pointed search engines at a sitemap. Each page now has its own title and description, a canonical address and Open Graph tags, and the landing page says what OpenReliant is in schema.org's terms. The docs' sitemap dates each page by its last commit, where it gave every page the build's date, and a sitemap of the website's own pages joins it. robots.txt at the root of openreliant.github.io names both.
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
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.
website/docs_hooks.py), in place of one description for all 82 pages.website/sitemap.xmllists the landing and contribute pages.Goes with OpenReliant/openreliant.github.io#1, robots.txt naming the sitemaps, and OpenReliant/openreliant-mods#79, the same for the mods' site.
Checked by building the docs locally with MkDocs 1.6: the 82 descriptions are all different, 80 to 159 characters, and the sitemap's dates match git.