search

pattern-lab / website

Pattern Lab's website: patternlab.io
http://patternlab.io
57 stars 33 forks source link

Update docs on PHP Pattern States #85

Closed EvanLovely closed 7 years ago

EvanLovely commented 7 years ago

I've made it so Pattern States in the PHP version are done just like the Node version with MD docs front matter over in this PR which is released in v2.8.3. The old behavior of button@inprogress.mustache still works with the new approach taking precedence, so I'm not sure if we want to leave something in the docs or what. I'd say no as now PHP & JS has taken one step towards acting similar (not to mention that renaming files with @inprogress sucked.

/cc @bradfrost @bmuenzenmeyer

bradfrost commented 7 years ago

@EvanLovely Fantastic! Thanks so much. This gets us closer to what we were talking about a bit ago with @bmuenzenmeyer to consolidate a lot of this stuff under the markdown files over file name conventions.

This as good a time as any to bring up documenting changes. How should we thinkg about current PL users who are using these conventions? Do the old conventions still work also? Should we update this page to talk about deprecating certain things? I'm sure there are conventions and presidents with all this stuff but I just wanted to flag it.

bmuenzenmeyer commented 7 years ago

Thanks for doing this Evan - didn't even realize the preferred method was not on there. The documenting patterns page will need a lot of work, if it is meant to describe everything you can do with pattern markdown.

Should we update this page to talk about deprecating certain things? I'm sure there are conventions and presidents with all this stuff but I just wanted to flag it.

I am hesitant to update a single page with all relevant deprecations or additions, especially with two platforms each having their own release cycles. I think that's what release notes and changelogs are for