Skip to content

Add build.apiPrefix to configuration-reference#14130

Open
ryechus wants to merge 2 commits into
withastro:mainfrom
ryechus:mhardin/add-build-apiPrefix
Open

Add build.apiPrefix to configuration-reference#14130
ryechus wants to merge 2 commits into
withastro:mainfrom
ryechus:mhardin/add-build-apiPrefix

Conversation

@ryechus

@ryechus ryechus commented Jun 23, 2026

Copy link
Copy Markdown

Description

This PR adds documentation for a new configuration option build.apiPrefix that is added in a PR on the main repo.

For Astro version: 7.0.3. See astro PR 17121.

Find me on discord: @thxmikezilla

@astrobot-houston

astrobot-houston commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

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/reference/configuration-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.

@astrobot-houston

Copy link
Copy Markdown
Contributor

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

  1. Our GitHub bots will run to check your changes.
    If they spot any broken links you will see some error messages on this PR.
    Don’t hesitate to ask any questions if you’re not sure what these mean!

  2. In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳.

  3. One or more of our maintainers will take a look and may ask you to make changes.
    We try to be responsive, but don’t worry if this takes a few days.

@ArmandPhilippot

Copy link
Copy Markdown
Member

Thank you ! I can't do a full review tonight (for me, CET), but if you want to make changes in between, I'll copy what is stated at the beginning of this file:

# NOTE: This file is auto-generated from 'scripts/docgen.mjs'
# Do not make edits to it directly, they will be overwritten.
# Instead, change this file: https://github.com/withastro/astro/blob/main/packages/astro/src/types/public/config.ts
# Translators, please remove this note and the <DontEditWarning/> component. 

This means this file is read-only and the content comes from the JSDoc in https://github.com/ryechus/astro/blob/c1f212b47585f7c5869e47cd13ffc4ebfce12b08/packages/astro/src/types/public/config.ts#L1203-L1226

Currently, the two do not match. And since JSDoc serves as public documentation, you will likely want something that falls somewhere between the two descriptions.

If this is a config only change (I haven't checked in details the implementation), you might not need a docs PR and the JSDoc is enough. If it affects more pages (e.g. https://docs.astro.build/en/guides/server-islands/), we'll need a docs PR for those pages, but you can omit configuration-reference.mdx (unless this is a 1:1 match and you want to check the rendering, then it's okay)!

@ryechus

ryechus commented Jun 23, 2026

Copy link
Copy Markdown
Author

Thank you ! I can't do a full review tonight (for me, CET), but if you want to make changes in between, I'll copy what is stated at the beginning of this file:

# NOTE: This file is auto-generated from 'scripts/docgen.mjs'
# Do not make edits to it directly, they will be overwritten.
# Instead, change this file: https://github.com/withastro/astro/blob/main/packages/astro/src/types/public/config.ts
# Translators, please remove this note and the <DontEditWarning/> component. 

This means this file is read-only and the content comes from the JSDoc in https://github.com/ryechus/astro/blob/c1f212b47585f7c5869e47cd13ffc4ebfce12b08/packages/astro/src/types/public/config.ts#L1203-L1226

Currently, the two do not match. And since JSDoc serves as public documentation, you will likely want something that falls somewhere between the two descriptions.

If this is a config only change (I haven't checked in details the implementation), you might not need a docs PR and the JSDoc is enough. If it affects more pages (e.g. https://docs.astro.build/en/guides/server-islands/), we'll need a docs PR for those pages, but you can omit configuration-reference.mdx (unless this is a 1:1 match and you want to check the rendering, then it's okay)!

Thank you! I'll try to fix this up before you get online tomorrow!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants