Skip to content

feat(ipa): Declutter the guideline header and add a collapsible Details group#71

Open
andmatei wants to merge 1 commit into
mainfrom
andmatei/guideline-ui-declutter
Open

feat(ipa): Declutter the guideline header and add a collapsible Details group#71
andmatei wants to merge 1 commit into
mainfrom
andmatei/guideline-ui-declutter

Conversation

@andmatei

@andmatei andmatei commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Before → After

Before After
Tag in the header; examples sprawl down the page. No tag; examples + workflow collapse into one "Details" group.

What changed

  • Header — removed the Informational/Enforced badge (the informational field stays in the metadata). The header now hides when it has nothing to show, and "Lint rule ↗" sits next to the state badge instead of far-right.
  • Grouping — new <Guideline.Details>: wrap a guideline's <Example.*> + <Workflow> in it and they collapse into one "Details" accordion below the prose (overridable title). <Guideline> renders its children verbatim.
  • ConfigshowWorkflows: true; workflows render inside the accordion.
  • Authoring — VS Code snippets scaffold the wrapper (guideline-lintable, guideline-unlintable, guideline-details).
  • Dev fixturesipa/dev/component-fixtures.mdx restructured: a full example up top, then one section per component.

@andmatei andmatei requested a review from a team as a code owner June 16, 2026 14:51
@andmatei andmatei force-pushed the andmatei/guideline-ui-declutter branch 3 times, most recently from 209156e to f7aaa0a Compare June 16, 2026 15:45
@andmatei andmatei marked this pull request as draft June 16, 2026 16:13
@andmatei andmatei force-pushed the andmatei/guideline-ui-declutter branch 4 times, most recently from bd5f946 to 9cbfed8 Compare June 17, 2026 16:02
@andmatei andmatei changed the title feat(ipa): declutter Guideline header and group examples + workflow feat(ipa): Declutter the guideline header and add a collapsible Details group Jun 17, 2026
@andmatei andmatei force-pushed the andmatei/guideline-ui-declutter branch from 9cbfed8 to e092963 Compare June 17, 2026 16:13
…ls group

- Remove the Informational/Enforced badge from the guideline header; the
  `informational` field stays in the metadata.
- Add <Guideline.Details>: a collapsible "Details" accordion (overridable
  title) that authors wrap a guideline's examples + workflow in, so the rule's
  prose stays visible and the supporting detail collapses below it.
- <Guideline> renders its children verbatim — no child introspection.
- Show workflows site-wide (showWorkflows: true) now that they live inside the
  Details accordion.
- Restructure the dev fixtures page; wrap IPA-100's example in Details.
- Update the VS Code authoring snippets to wrap examples/workflow in
  <Guideline.Details> (and add a guideline-details snippet); use the 3-digit
  ID placeholder.
@andmatei andmatei force-pushed the andmatei/guideline-ui-declutter branch from e092963 to 8347f52 Compare June 17, 2026 16:21
@andmatei andmatei marked this pull request as ready for review June 17, 2026 16:25

@yelizhenden-mdb yelizhenden-mdb left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you!

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