Skip to content

Conversation

@jmuzina
Copy link
Member

@jmuzina jmuzina commented Dec 1, 2025

Done

Updates the "elements" documentation of some patterns that were previously describing their APIs instead of their elements. The idea is that pattern elements docs should focus on the elements that compose the patterns, not their APIs. A separate API section describes the parameters at a more engineering level.

Fixes WD-31507
Fixes #5698

QA

  • Review documentation of updated patterns and ensure the "elements" section is clear and only describes high-level lists of content that is passed to the pattern. Also ensure that the Jinja API section fully describes the API and no API information that was previously in the elements section has been lost.

Check if PR is ready for release

If this PR contains Vanilla SCSS or macro code changes, it should contain the following changes to make sure it's ready for the release:

  • PR should have one of the following labels to automatically categorise it in release notes:
    • Feature 🎁, Breaking Change 💣, Bug 🐛, Documentation 📝, Maintenance 🔨.
  • Vanilla version in package.json should be updated relative to the most recent release, following semver convention
    • if existing APIs (CSS classes & macro APIs) are not changed it can be a bugfix release (x.x.X)
    • if existing APIs (CSS classes & macro APIs) are changed/added/removed it should be a minor version (x.X.0)
    • see the wiki for more details
  • Any changes to component class names (new patterns, variants, removed or added features) or macros should be listed on the what's new page.

@webteam-app
Copy link

@jmuzina jmuzina added Review: Percy needed This PR needs a review of Percy for visual regressions and removed Review: Percy needed This PR needs a review of Percy for visual regressions labels Dec 1, 2025
@jmuzina jmuzina mentioned this pull request Dec 3, 2025
3 tasks
@jmuzina
Copy link
Member Author

jmuzina commented Dec 8, 2025

Content approved via MM message by @Sophie-32 - will still need GitHub approval by another engineer CC @advl

@jmuzina jmuzina requested a review from advl December 8, 2025 14:23
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.

Pattern docs "elements" sections should describe components, not API parameters

4 participants