docs: SEO metadata, social cards, and sitemap for the docs site#314
Merged
Conversation
- Richer meta description + keywords; canonical URL. - Open Graph + Twitter (summary_large_image) card tags with a branded 1200x630 og-image.png (brand palette), for link unfurls on social/Slack/etc. - sitemap.xml (VitePress sitemap with hostname) + robots.txt pointing at it, for search-engine crawling. - favicon.svg (brand mark); cleanUrls for tidier, more shareable URLs. GitHub repo metadata also set (separately, via API): homepage → scttfrdmn.github.io/substrate, 15 discovery topics (aws, aws-emulator, testing, cloudformation, terraform, localstack-alternative, event-sourcing, ...). Verified: npm run build emits sitemap.xml + robots.txt + assets; built HTML carries og:*/twitter:*/canonical with absolute image URL.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
Improves findability across both surfaces.
Docs site (this PR)
description,keywords, andcanonicalURL.summary_large_imagetags, with a branded 1200×630og-image.png(brand palette) so links unfurl nicely on social, Slack, etc. Absolute image URL (crawler requirement).sitemap.xml(VitePress sitemap with hostname) +robots.txtpointing at it.favicon.svgbrand mark;cleanUrlsfor tidier shareable URLs (/scopenot/scope.html— GitHub Pages serves both).GitHub repo (already applied via API, not in this diff)
aws,aws-emulator,testing,go,golang,cloudformation,terraform,aws-cdk,localstack-alternative,event-sourcing,infrastructure-as-code,mock,devops,boto3,integration-testing.Verification
npm run buildemitssitemap.xml,robots.txt, and the image assets; built HTML carriesog:*/twitter:*/canonicalwith an absolute image URL. Deploys automatically to Pages on merge.