Skip to content

Use a consistent headings format in reference/modules#13315

Merged
ArmandPhilippot merged 3 commits into
v6from
armand/consistent-types-headings
Feb 26, 2026
Merged

Use a consistent headings format in reference/modules#13315
ArmandPhilippot merged 3 commits into
v6from
armand/consistent-types-headings

Conversation

@ArmandPhilippot
Copy link
Copy Markdown
Member

@ArmandPhilippot ArmandPhilippot commented Feb 26, 2026

Nothing urgent, just some polishing before v6. Context:

In a previous PR, 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)

Updates all the reference/modules to use a consistent heading format (and fix some links because of the changes).

I'll probably do the same for the other references, but not in this PR to keep the scope small and easily reviewable (e.g. api-reference.mdx requires to fix some links in the translations too!).

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 f887b21
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/69a0821b9472fe00085f82b4
😎 Deploy Preview https://deploy-preview-13315--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
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/content-collections.mdx Source changed, localizations will be marked as outdated.
en/reference/content-loader-reference.mdx Source changed, localizations will be marked as outdated.
en/reference/modules/astro-actions.mdx Source changed, localizations will be marked as outdated.
en/reference/modules/astro-assets.mdx Source changed, localizations will be marked as outdated.
en/reference/modules/astro-content.mdx Source changed, localizations will be marked as outdated.
en/reference/modules/astro-middleware.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.

@sarah11918
Copy link
Copy Markdown
Member

This looks great! I'm just checking the deploy preview now because the only potential thing NOT to like about this is what it does to the TOC right sidebar:

  • astro:actions: I suggest we take this back to a normal h2/h3 only
  • astro:assets: LGTM! (and I think is already only h2/h3
  • astro:content: I think I want to go back to h2/h3 here, too. It's not terrible, but I think these identifiers now mean we don't have to worry as much about exposing these
  • astro:middleware: again, I think I want to go back to h2/h3 here too now!

Maybe this is helping us in general with our TOCs!

Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
@ArmandPhilippot
Copy link
Copy Markdown
Member Author

Good call, much cleaner! And for imports/types reference this is probably enough levels in the TOC!

@sarah11918
Copy link
Copy Markdown
Member

Yeah, going to go out on a limb and suspect that ALL of these modules will look better with just h2/h3!

This one LGTM!

@ArmandPhilippot ArmandPhilippot merged commit 2ab3e5a into v6 Feb 26, 2026
10 checks passed
@ArmandPhilippot ArmandPhilippot deleted the armand/consistent-types-headings branch February 26, 2026 18:21
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.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants