Skip to content

feat(v6): add docs for astro/config module#13222

Open
ArmandPhilippot wants to merge 4 commits intov6from
armand/astro-config-module
Open

feat(v6): add docs for astro/config module#13222
ArmandPhilippot wants to merge 4 commits intov6from
armand/astro-config-module

Conversation

@ArmandPhilippot
Copy link
Member

@ArmandPhilippot ArmandPhilippot commented Feb 3, 2026

Description (required)

  • Adds docs for astro/config exports in our astro:config module reference:

    • defineConfig(): Not the easiest to describe... I was tempted by "Defines the configuration for" 😄
    • envField, I see two options (I chose the first one):
      1. We document everything here and we replace what's in Configuration reference with a link to that page. This declutters the configuration reference and we can more easily describe each envField methods.
      2. We only provide a link to the matching section in the Configuration reference.
    • fontProviders: pretty minimal because we already have a reference for all the providers
    • getViteConfig(): Added in Add getViteConfig helper astro#4154 (v1, so no Since). I don't know if there are other use cases than Vitest, linking to the Testing guide is probably enough.
    • mergeConfig(): moved from Programmatic Astro API with some rewording
    • passthroughImageService(): I reused the wording we had in the Images guide.
    • sessionDrivers: the object is pretty big, so I think it's fine to keep it minimal and use links, as with fontProviders.
    • sharpImageService(): not really added, but this is available from this module since fix: move service functions from astro/assets to astro/config so it can be imported astro#6995 and I'm not really quite sure about any use cases since Sharp is now the default image service.
    • validateConfig(): moved from Programmatic Astro API with some rewording
  • Updates the env.schema configuration reference as a preview of what it might look like if we update the JSDoc (see envField). If we're happy with that, we'll need to make a PR in the core repo!

Things to consider:

  • Should we add links to mergeConfig() and validateConfig() from the Programmatic Astro API page? I don't see any obvious place because the current content is focused on CLI commands executed programmatically. We might need to reword a bit the introduction if we want to add links.
  • Are we okay with the configuration reference change? We can also keep the previous description and just add a link to envField.

Related issues & labels (optional)

  • Suggested label: add new content, v6

@ArmandPhilippot ArmandPhilippot added add new content Document something that is not in docs. May require testing, confirmation, or affect other pages. 6.0 labels Feb 3, 2026
@netlify
Copy link

netlify bot commented Feb 3, 2026

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit 4b4b4ba
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/698371d10fbe6900074e153c
😎 Deploy Preview https://deploy-preview-13222--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 Feb 3, 2026

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/environment-variables.mdx Source changed, localizations will be marked as outdated.
en/reference/configuration-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/modules/astro-config.mdx Source changed, localizations will be marked as outdated.
en/reference/programmatic-reference.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.

@ArmandPhilippot ArmandPhilippot marked this pull request as ready for review February 4, 2026 16:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.0 add new content Document something that is not in docs. May require testing, confirmation, or affect other pages.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants