Publish docs crawler entry points and social previews - #141
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Publishes standard crawler discovery entry points and adds default social-preview metadata so documentation pages are reliably discoverable by crawlers and render consistent link previews when shared.
Changes:
- Add
public/robots.txtadvertising the sitemap index and permitting crawling. - Add
public/sitemap.xmlas a conventional sitemap entry point. - Add default Open Graph / Twitter preview images via Starlight
headconfig and introduce Node test coverage plus averifyscript.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| test/machine-files.test.mjs | Adds Node tests to validate robots.txt, sitemap.xml, and presence of social preview meta tags. |
| public/sitemap.xml | Introduces a conventional /sitemap.xml sitemap index entry point. |
| public/robots.txt | Introduces a permissive robots.txt that advertises the sitemap index URL. |
| package.json | Adds test and verify scripts to run Node tests and build. |
| astro.config.js | Adds global Open Graph and Twitter image meta tags for social previews. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
HDauven
marked this pull request as ready for review
August 16, 2026 22:18
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.
Summary
Addresses audit finding AR-09 and the documentation social-preview gap.
/robots.txtwith an allow policy and the real sitemap-index URL/sitemap.xmlcompatibility URL as an exact build-time copy of Astro's generated sitemap indexRoot cause and impact
The documentation sitemap existed at
/sitemap-index.xml, but the standard/robots.txtand/sitemap.xmldiscovery paths returned 404. Agents and crawlers that probe only conventional entry points could therefore miss an otherwise complete sitemap.The compatibility URL is generated from Astro's actual sitemap index after every build. It cannot silently drift if Astro later splits the sitemap into additional child files or changes their numbering.
Validation
esbuilddependency was explicitly rebuiltnpm run verify: 3 tests passed; 64 pages built/robots.txt,/sitemap.xml, and/sitemap-index.xmlreturned the expected outputs/404route-conflict warning is unchangedSecurity and remaining risk
This introduces no secrets, write permissions, deployment actions, or publication behavior. The workflow retains read-only repository permissions and does not persist checkout credentials.
The repository's existing dependency audit findings are not introduced by this PR and should be handled separately.
Deployment and rollback
No content migration is required. Deploy through the normal docs pipeline. Roll back by reverting this PR.
Post-deployment checks
/robots.txt,/sitemap.xml, and/sitemap-index.xml/sitemap.xmlexactly matches the generated sitemap indexDeliberately not included
This PR does not choose product statuses, replace legacy client-side redirect shells, invent page review dates, or synthesize sitemap
lastmodvalues. Those require content ownership and/or routing changes.