pattern-lab / patternlab-php-core

This repository provides the core functionality for Pattern Lab. It is meant to be used from within an Edition with a PatternEngine and StarterKit.
http://patternlab.io/
MIT License
43 stars 62 forks source link

Implementing Pattern Type (ie atoms) Documentation #141

Closed EvanLovely closed 6 years ago

EvanLovely commented 6 years ago

This allows MD docs to be added to the top levels, such as Atoms.

Given this structure:

This will take the contents of atoms.md and place at top of "Atoms > View All", similar to how forms.md is placed at top of "Atoms > Forms > View All".

As @bradfrost said on the Spec discussion:

As someone who has to re-explain UI component hierarchy over and over again, I'm in favor of this.

I think this will really help teams who have to describe what should be a molecule or organism and other common questions on the high section level.

Spec link: https://github.com/pattern-lab/the-spec/issues/28

/cc @bmuenzenmeyer