Skip to content

docs(headless): revamp docsite with Overview, Getting Started, and Accessibility pages#36120

Open
dmytrokirpa wants to merge 5 commits into
microsoft:masterfrom
dmytrokirpa:docs/headless-docsite-improvements
Open

docs(headless): revamp docsite with Overview, Getting Started, and Accessibility pages#36120
dmytrokirpa wants to merge 5 commits into
microsoft:masterfrom
dmytrokirpa:docs/headless-docsite-improvements

Conversation

@dmytrokirpa
Copy link
Copy Markdown
Contributor

@dmytrokirpa dmytrokirpa commented May 7, 2026

Summary

  • Restructure headless docsite navigation into Overview (Introduction, Getting Started, Accessibility), Guides, Components, and Concepts groups.
  • Replace the introduction page with a richer landing experience (hero + feature/why grids) and add new Getting Started and Accessibility pages.
  • Brand Storybook chrome with a logo + sidebar label, wire the package CHANGELOG into preview parameters, and rename the story group from Headless Components/* to Components/* across all stories (and the README example).

…cessibility pages

Restructure the headless components docsite navigation into Overview, Guides,
Components, and Concepts groups. Replace the introduction page with a richer
landing experience (hero + feature/why grids) and add Getting Started and
Accessibility pages. Brand the Storybook chrome with a logo and rename the
"Headless Components" story group to "Components".

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

📊 Bundle size report

✅ No changes found

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 7, 2026

Pull request demo site: URL

@dmytrokirpa dmytrokirpa marked this pull request as ready for review May 11, 2026 09:39
@dmytrokirpa dmytrokirpa requested review from a team as code owners May 11, 2026 09:39
@dmytrokirpa dmytrokirpa self-assigned this May 11, 2026
Copy link
Copy Markdown
Contributor

@Hotell Hotell left a comment

Choose a reason for hiding this comment

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

left some comments to discuss, otherwise nothin blocking

@@ -0,0 +1,147 @@
.hero {
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.

is using css modules the path forward for everything ? it seems it's not the best approach and moves us to another vendor lock. eg for our storybook addon we used historically griffel, which is now in conflict when providing shared experiences across v9 and vH storybooks ( i have some work started where we switch to SB styled theming approach to be out of our own vendor lock )

to sum it up: if possible we should use generic styling solution for things outside code examples

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I don't have any preferences in regards of CSS Modules vs Griffel, I just wanted to re-use the same tokens/styles we have for the SB docs, and can easily convert it to Griffel if that's what we want to have in docs

/** @type {typeof headlessPreview.parameters} */
export const parameters = {
...headlessPreview.parameters,
changelog: headlessChangelog,
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.

is this some new native SB experience of rendering changelogs or how is this supposed to work ?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It was an attempt to show the package changelog on a separate page, but it doesn't seem to be useful, so I reverted it.

This is leftover and also need to be reverted

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.

where are these coming from.

nit: why is the checkmark no centered ? looks odd

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

all are AI generated, I'll fix the checkmark alignment

ty!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants