Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] test config-reference formatting for sidebar #9052

Merged
merged 6 commits into from
Nov 10, 2023

Conversation

sarah11918
Copy link
Member

Changes

Changes Prefetch and i18n into headings to see if I can get the docs sidebar nested properly

Testing

This is a test! The automated PR for docs will let me test the output

Docs

Just docs!

Copy link

changeset-bot bot commented Nov 10, 2023

⚠️ No Changeset found

Latest commit: aa788e7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions bot added pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review labels Nov 10, 2023
Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don’t think this will do what you want!

@delucis
Copy link
Member

delucis commented Nov 10, 2023

(Speed reviewed in case Ema’s approval made you merge this 😅)

I’m pretty sure our logic in docs only distinguishes between @heading and blocks without @heading. So these you’ve added would pull these out to be h2s like this:

image image

Breaking for lunch, but we can take a look at a solution when I’m back. (FWIW the current version is potentially OK I think as it matches e.g. how we handle the build.* headings.)

@sarah11918
Copy link
Member Author

For Prefetch I think that works, if it's moved to other things that work that way! I'd really just want the experimental flag to show up as a one-liner, I think though:

image
image

@delucis
Copy link
Member

delucis commented Nov 10, 2023

Ah, yes, that makes sense. In that case, we probably also need to move the whole prefetch block AFTER the build options?

@sarah11918
Copy link
Member Author

Yes, but I'm still not sure how to make the i18n options not show up in the sidebar

Copy link
Member

@ElianCodes ElianCodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

Copy link
Member

@delucis delucis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great @sarah11918! Glad we’re no longer JSBlocked 🚀

@sarah11918
Copy link
Member Author

Thanks for your help with this, @delucis ! This is now headings in the right direction!

@sarah11918 sarah11918 merged commit aa4ef8a into main Nov 10, 2023
14 checks passed
@sarah11918 sarah11918 deleted the sarah11918-patch-4 branch November 10, 2023 19:23
natemoo-re pushed a commit that referenced this pull request Nov 22, 2023
Co-authored-by: Chris Swithinbank <357379+delucis@users.noreply.github.com>
Co-authored-by: Emanuele Stoppa <602478+ematipico@users.noreply.github.com>
Co-authored-by: Elian <15145918+ElianCodes@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pkg: astro Related to the core `astro` package (scope) pr: docs A PR that includes documentation for review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants