Repository navigation
refactor: write the sitemap, robots file and metadata partial from the website package - #518
Merged
Merged
Conversation
The partial that carries page titles, translation metadata, the Open Graph page type and the build time is now composed and registered by a website feature module instead of the documentation builder. The module reports an invalid title template through a callback rather than printing it; the build prints the same warning as before.
The sitemap and robots writers, and the step that runs both after the site is rendered, now live beside the other SEO features instead of in the documentation builder. The build and `great-docs seo --fix` resolve the canonical site address once and pass it to the writers, which report their progress through a callback. Both print the same lines as before, and a failed write after rendering still only warns.
📚 Preview this PR's docs locallyFetch the just-built site and open it in your browser: # this exact build
great-docs preview --run 41629959693
# or always the latest build for this PR
great-docs preview --pr 518Auth & tips
|
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.
The code that writes
sitemap.xml,robots.txtand the HTML metadata partial now lives beside the other SEO and website features instead of in the documentation builder. Built sites are unchanged, and the build andgreat-docs seo --fixprint the same lines as before.These writers printed their own messages and each looked up the site's canonical address, which tied them to the builder. They now take the address from their caller and report through a callback, so the build and the
seocommand share them directly.