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] reorder items for configuration reference page #9815

Merged
merged 4 commits into from
Jan 24, 2024

Conversation

sarah11918
Copy link
Member

@sarah11918 sarah11918 commented Jan 24, 2024

Changes

This reorders the @docs items for building the Docs Configuration Reference Page. There is no content change, only organizational changes. This should only affect how the docs page is generated (the order of items).

(File diffs may imply otherwise, because of similar text repeated throughout. But there have been no changes to any text. Only moving items around and attempting to get the indentation correct.)

  • It reorganizes similar items together in an order that more reflects what people are asking about and looking for.

  • It moves integrations and vite into the top-level category instead of making them standalone headers at the bottom of the page, mixed in with config items that do have several sub-options, taking care to:

    • remove the @heading property
    • change the name to lower case

Testing

No tests, only docs. Not sure why tests are failing.

Docs

I hope I got all the indentations correct

Copy link

changeset-bot bot commented Jan 24, 2024

⚠️ No Changeset found

Latest commit: db28fa4

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 Jan 24, 2024
Copy link
Member

@TheOtterlord TheOtterlord left a comment

Choose a reason for hiding this comment

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

Adding types for integrations & vite, but looks good otherwise

packages/astro/src/@types/astro.ts Show resolved Hide resolved
packages/astro/src/@types/astro.ts Show resolved Hide resolved
natemoo-re and others added 3 commits January 24, 2024 15:56
Co-authored-by: Reuben Tier <64310361+TheOtterlord@users.noreply.github.com>
Co-authored-by: Reuben Tier <64310361+TheOtterlord@users.noreply.github.com>
Copy link
Member

@natemoo-re natemoo-re left a comment

Choose a reason for hiding this comment

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

LGTM!

@natemoo-re natemoo-re merged commit edb5437 into main Jan 24, 2024
14 checks passed
@natemoo-re natemoo-re deleted the docs-config-ref-order branch January 24, 2024 22:20
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.

3 participants