Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@Shinigami92
Copy link
Member

@Shinigami92 Shinigami92 commented Dec 18, 2025

Improve SEO with robots.txt and sitemap.xml (autogenerated)

for local evaluation, you need to serve a prod generated docs.


Preview:

@Shinigami92 Shinigami92 self-assigned this Dec 18, 2025
@Shinigami92 Shinigami92 requested a review from a team as a code owner December 18, 2025 17:14
@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label Dec 18, 2025
@netlify
Copy link

netlify bot commented Dec 18, 2025

Deploy Preview for fakerjs ready!

Name Link
🔨 Latest commit 2a8240b
🔍 Latest deploy log https://app.netlify.com/projects/fakerjs/deploys/6944366f6fa16000085251a1
😎 Deploy Preview https://deploy-preview-3675.fakerjs.dev
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@codecov
Copy link

codecov bot commented Dec 18, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.97%. Comparing base (ec09440) to head (2a8240b).

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:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@matthewmayer
Copy link
Contributor

How will this work with different subdomains? Like should next.fakerjs.dev/sitemap.xml point to a different domain?

@Shinigami92
Copy link
Member Author

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.
The main audience should normally rely on the official docs of the current release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

c: docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants