Skip to content

fix: consistent headings format in api-reference.mdx#13316

Merged
ArmandPhilippot merged 3 commits intov6from
armand/consistent-types-headings-api-reference
Feb 27, 2026
Merged

fix: consistent headings format in api-reference.mdx#13316
ArmandPhilippot merged 3 commits intov6from
armand/consistent-types-headings-api-reference

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Feb 26, 2026

Same as #13315

For context: In a #13021 (comment), we decided we preferred Type.prop (or object.prop) as headings instead of prop both for readability and linking. We already use this format in some modules reference (e.g. envField) but most of the modules were using the old format (e.g. action).

Description (required)

Uses a consistent heading format in api-reference.mdx.

Note that we'll need to update the config file in core to fix a link. I'll check the other references before to avoid doing this multiple times.

Related issues & labels (optional)

  • Suggested label: v6, consistency/formatting

@ArmandPhilippot ArmandPhilippot added consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. 6.0 labels Feb 26, 2026
@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 26, 2026

Deploy Preview for astro-docs-2 ready!

Name Link
🔨 Latest commit f62daa2
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/69a1c0968147b1000854f4a7
😎 Deploy Preview https://deploy-preview-13316--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.

@github-actions github-actions Bot added the i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help! label Feb 26, 2026
@astrobot-houston
Copy link
Copy Markdown
Contributor

astrobot-houston commented Feb 26, 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/sessions.mdx Source changed, localizations will be marked as outdated.
en/reference/api-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/configuration-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/integrations-reference.mdx Source changed, localizations will be marked as outdated.
ja/guides/sessions.mdx Localization changed, will be marked as complete.
pl/guides/sessions.mdx Localization changed, will be marked as complete.
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
Copy Markdown
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.

This one looks great, too!

@ArmandPhilippot
Copy link
Copy Markdown
Member Author

ArmandPhilippot commented Feb 26, 2026

Thank you!

Just noting that I wait to check the other references before merging this in order to make a single PR in core if other files also affect the configuration reference! (this shouldn't take weeks 😄 )

@ArmandPhilippot
Copy link
Copy Markdown
Member Author

I'll check the links in the core repo and make a PR, so this one is ready to go!

@ArmandPhilippot ArmandPhilippot merged commit c28bf38 into v6 Feb 27, 2026
11 checks passed
@ArmandPhilippot ArmandPhilippot deleted the armand/consistent-types-headings-api-reference branch February 27, 2026 16:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.0 consistency/formatting Standardizing without changing docs content e.g. indenting, lists etc. i18n Anything to do with internationalization & translation efforts - ask @YanThomas for help!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants