Skip to content

Conversation

@DavidMoore
Copy link

@DavidMoore DavidMoore commented Nov 22, 2025

Link: preview

This PR is a tiny correction to a documentation example.

In the example for the Layout components, the header has the class applied using a style attribute instead of a class attribute.

image

Testing

Build the documentation site

  1. npm install
  2. npm run build:site
  3. npm run serve:site

Verify example

  1. Navigate to Layout Component Docs
  2. Under Important Concepts > Markup structure, verify the example HTML code

Expected result:

<html class="layout layout-{nameoflayout}">
    <body class="layout-body">
+      <header class="layout-body-header">Header</header>
        <section aria-label="hero" class="layout-body-hero">Hero</section>
        <nav class="layout-body-menu">Menu</nav>
        <main class="layout-body-main">Main</main>
        <aside class="layout-body-aside">Aside</aside>
        <footer class="layout-body-footer">Footer</footer>
    </body>
</html>

Contributor checklist

  • Did you update the description of this pull request with a review link and test steps?
  • Did you submit a changeset? Changesets are required for all code changes.
  • Does your pull request implement complex UI logic (js/ts)? Consider adding an integration test to test your user flow.
  • Does your pull request add a new page to the documentation site? Add your new page for automated accessibility testing in /integration/tests/accessibility.
  • Does your pull request change any transforms? Did you test they work on right to left?

@changeset-bot
Copy link

changeset-bot bot commented Nov 22, 2025

⚠️ No Changeset found

Latest commit: d6b4a4b

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

@DavidMoore DavidMoore marked this pull request as ready for review November 22, 2025 02:57
@DavidMoore DavidMoore requested a review from a team as a code owner November 22, 2025 02:57
@DavidMoore DavidMoore changed the title Fix Layout example HTML DOCS: Fix Layout example HTML Nov 22, 2025
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.

1 participant