docs: add sitemap configuration and robots.txt for SEO #3675
Conversation
✅ Deploy Preview for fakerjs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## next #3675 +/- ##
=======================================
Coverage 99.97% 99.97%
=======================================
Files 2995 2995
Lines 236313 236313
Branches 941 940 -1
=======================================
Hits 236256 236256
Misses 57 57 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
This PR adds SEO improvements by configuring automated sitemap generation and adding a robots.txt file to help search engines discover and index the documentation site.
- Added sitemap configuration to VitePress config with the production hostname
- Created robots.txt file with sitemap reference for search engine crawlers
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/.vitepress/config.ts | Added sitemap configuration with hostname for automated sitemap.xml generation |
| docs/public/robots.txt | Created robots.txt file directing crawlers to the sitemap location |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
How will this work with different subdomains? Like should next.fakerjs.dev/sitemap.xml point to a different domain? |
I had the same question in my head and decided to ignore that for the first iteration. I'm not sure if other subdomains are real in need to be effectively crawled by bots. |
|
On netlify you can use the URL env, you would need a small script on build. https://docs.netlify.com/build/configure-builds/environment-variables/ |
Note that we then also need to automatically generate the |
Improve SEO with robots.txt and sitemap.xml (autogenerated)
for local evaluation, you need to serve a prod generated docs.
Preview: