Skip to content

docs: new section updates#2023

Open
cherylpaulsen wants to merge 21 commits intomasterfrom
docs-section-updates
Open

docs: new section updates#2023
cherylpaulsen wants to merge 21 commits intomasterfrom
docs-section-updates

Conversation

@cherylpaulsen
Copy link
Copy Markdown
Collaborator

Primary changes are:

  • Applied the new docSections to Accordion, Badge and Button docs and removed the old additional array
  • Renamed Usage section to Best practices
  • Moved Accessibility and Alternatives to sit under Best practices
  • Added a hacky style override for Heading level=2 to land on the look and feel
Cursor-change-summary

@cherylpaulsen cherylpaulsen requested a review from a team as a code owner March 25, 2026 00:51
@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Mar 25, 2026

⚠️ No Changeset found

Latest commit: c105cda

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.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's delete this file for now and revert back to the existing h2 styles.

I'll address the styling of these headings as part of a followup with the 'Jump to' feature by creating a new CategoryHeading component given it's used in that menu as well

Build the ToC sections
- Accessibility
- Each docSection and their children
- Accessibility (top-level when no bestPractices section, otherwise nested within it)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

With this change we're reordering where accessibility sits within the docs. Previously we were treating accessibility as high-importance by consistently elevating it to the second item on the page.

I feel like we should retain that pattern, but open to discussion. Thoughts @michaeltaranto ?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Happy to revert if we think that's best. Just worth noting, if we do 'Accessibility' will be the only section not assigned to a docSection. Maybe it's okay tho given it would be at the top of the page before any other H2

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I've reverted the change so 'Accessibility' renders at the top again 😎 @SEEKilian

<Stack space="large">
<Heading level="4">Critical</Heading>
<Text>
For destructive actions like “Delete” you can set the
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

These quotations should be replace with HTML entities

Also present on the following line is an &rsquo; where an &apos; should be used.

<TextLink href="/components/Heading">Heading</TextLink> element
using an <TextLink href="/components/Inline">Inline</TextLink>,
even though the button is actually taller than the heading. If we
didn’t use the <Strong>bleed</Strong> prop in this case, the
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This should be replace with an &apos;

@cherylpaulsen cherylpaulsen requested a review from SEEKilian March 31, 2026 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants