-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
fix(sitemap): add API references to config options #12304
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(sitemap): add API references to config options #12304
Conversation
✅ Deploy Preview for astro-docs-2 ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
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.
All this looks great, @ArmandPhilippot ! I think you've handled that one section with three options (😅 ) very reasonably!
The inline linking looks great, too!
Deploy preview is looking good, so I think this one is good to go! I think it's fine (probably preferable?) if it merges first, especially since we won't release 5.14 until the end of next week, then we update the other PR and handle any conflicts there.
|
Sounds like a good plan to me! I added a small update (I knew I had forgotten something): wrapping each option name with backticks! This matches what we describe in API references and the formatting used in the other PR. After that, I think this is ready to go! |
|
Ship it! 🫡 |
|
Thanks, I wasn't sure if I should merge it after the small update or wait for a second look! Spoiler: other integration guides are coming! Except the |
Description (required)
Type,DefaultandSinceto the sitemap config options:filter,customPagesandcanonicalURLwere added in0.1.0which predates Astro v1.0.0, so noSincefor them!entryLimit,serializeandi18nso I guess those also predate Astro v1.0.0changefreq,lastmodandprioritywere added in0.2.0which was released as the same time as[email protected](see feat: improved sitemap astro#3579)i18ntypes inside the description to avoid redundancyi18noption into the description (looking at the history - Add official integration READMEs to docs #954 - this was the format used in the README at the time and it was never updated)I wasn't totally sure how to deal with
changefreq, lastmod, and prioritysince they are all described in the same heading. I used an object to define the types but I'm open to other ideas!Related issues & labels (optional)
consistency/formatting,improve or update documentationThis doesn't have to wait for #12250 but just noting the
integrations-guide/sitemap.mdxfile is also updated there (potential Git conflict?).