Skip to content

Conversation

@ArmandPhilippot
Copy link
Member

Description (required)

  • Adds Type, Default and Since to the sitemap config options:
    • filter, customPages and canonicalURL were added in 0.1.0 which predates Astro v1.0.0, so no Since for them!
    • I couldn't find a PR/commit for entryLimit, serialize and i18n so I guess those also predate Astro v1.0.0
    • changefreq, lastmod and priority were added in 0.2.0 which was released as the same time as [email protected] (see feat: improved sitemap astro#3579)
    • others are listed in the changelog
  • Removes the i18n types inside the description to avoid redundancy
  • Incorporates both "Read more" links of the i18n option 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 priority since 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)

  • Suggested label: consistency/formatting, improve or update documentation

This doesn't have to wait for #12250 but just noting the integrations-guide/sitemap.mdx file is also updated there (potential Git conflict?).

@ArmandPhilippot ArmandPhilippot added improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. labels Sep 11, 2025
@netlify
Copy link

netlify bot commented Sep 11, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit f1b6335
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/68c4718c604fa4000872aa85
😎 Deploy Preview https://deploy-preview-12304--astro-docs-2.netlify.app
📱 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.

@astrobot-houston
Copy link
Contributor

astrobot-houston commented Sep 11, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/guides/integrations-guide/sitemap.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Member

@sarah11918 sarah11918 left a 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.

@ArmandPhilippot
Copy link
Member Author

ArmandPhilippot commented Sep 12, 2025

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!

@sarah11918
Copy link
Member

Ship it! 🫡

@ArmandPhilippot
Copy link
Member Author

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 db one (a bit more tricky because of zod), I think I have everything ready but I didn't want to spoil your week-end so this will wait for next week. 😄

@ArmandPhilippot ArmandPhilippot merged commit 7642316 into withastro:main Sep 12, 2025
10 checks passed
@ArmandPhilippot ArmandPhilippot deleted the fix/integrations-guide/sitemap-add-api-reference branch September 12, 2025 19:23
ArmandPhilippot added a commit to ArmandPhilippot/astro-docs that referenced this pull request Sep 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants