Use a consistent headings format in reference/modules#13315
Conversation
✅ Deploy Preview for astro-docs-2 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
|
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:
Maybe this is helping us in general with our TOCs! |
Co-authored-by: Sarah Rainsberger <5098874+sarah11918@users.noreply.github.com>
|
Good call, much cleaner! And for imports/types reference this is probably enough levels in the TOC! |
|
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! |
Nothing urgent, just some polishing before v6. Context:
In a previous PR, we decided we preferred
Type.prop(orobject.prop) as headings instead ofpropboth 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/modulesto 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.mdxrequires to fix some links in the translations too!).Related issues & labels (optional)