-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(docs): Update @astrojs/sitemap
readme to clarify build output location
#8844
Conversation
|
@astrojs/sitemap
readme to clarify build output location@astrojs/sitemap
readme to clarify build output location
@astrojs/sitemap
readme to clarify build output location@astrojs/sitemap
readme to clarify build output location
@withastro/maintainers-docs this is your turf, please review :) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm 😄
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you so much for this helpful restructuring, @evadecker! 🥳
It's a great tweak to the existing sentence to more properly identify the sitemap files. I'd like to work on the ending though, since we don't typically use em-dashes in docs. That probably means either sticking another clause on the end, or using parenthesis to include the extra information of the default output directory.
I left a comment with a suggestion below. See what you think, or if that gives you any better ideas. 🙌
Co-authored-by: Sarah Rainsberger <sarah@rainsberger.ca>
I respect killing the em dash—I overuse it. :) Great suggestion @sarah11918, applied! |
Changes
/dist
is the default output, but generated files may live elsewhere (a confusion that cost me a silly amount of time trying to debug)..vercel/output
and that other adapters may output code to a place other than/dist
, but this felt too in-the-weeds. If this is helpful to call out, happy to make edits!@astrojs/sitemap
does not always output sitemaps todist/
docs#4919 (Not sure if Github will auto-close this PR since it's in a separate repo, but the sitemap docs get auto-generated from this README)Testing
Docs-only change.