Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(documentation): added (sub)groups documentation again #1262 #1334

Conversation

mfranzke
Copy link
Contributor

@mfranzke mfranzke commented Jun 19, 2021

Closes #1262

Summary of changes:

Readded the functionality of showing the documentation for subgroups again – having some documentation for the groups as well is being prepared by this, but probably didn't work previous to the deletion of the documentation of the subgroups by #1252 anyhow.

Solution

We use the markdown content provided within the (sub)groups companion .md files, which are even already defined like this for the ordering.

That for some demo content has been added to the buttons subgroup, compare to the rendered result.

Additionally some documentation has been adapted from the reorganizing patterns page.

@mfranzke mfranzke marked this pull request as draft June 19, 2021 20:07
@mfranzke mfranzke marked this pull request as ready for review June 19, 2021 21:16
Copy link
Contributor

@JosefBredereck JosefBredereck left a comment

Choose a reason for hiding this comment

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

As always, your Pull Request description is excellent 🥇

packages/docs/src/docs/pattern-documenting.md Outdated Show resolved Hide resolved
packages/core/src/lib/ui_builder.js Show resolved Hide resolved
@mfranzke mfranzke marked this pull request as draft June 21, 2021 17:32
@mfranzke mfranzke marked this pull request as ready for review June 21, 2021 17:32
@JosefBredereck JosefBredereck merged commit 9fac269 into pattern-lab:dev Jun 21, 2021
@mfranzke mfranzke deleted the feat/documentation-pattern-groups-and-subgroups branch June 21, 2021 17:45
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.

Add documentation to pattern group and subgroup
2 participants