Documentation

[priley86]

API Documentation

We'd like to choose a tool which generates API docs for our code. To date in Patternfly, we've used tools like jsdoc. What kinds of API docs would you prefer to see used?

Showcase Documentation

We have a few tools being used in Patternfly today for showcasing our components. There is patternfly.org, patternlab (for patternfly-css) demo, and our patternfly-webcomponents site. What kind of showcase site style would we like?

Component / Widget Documentation

Today in Patternfly, we use test pages for sharing our new components. We also build these in Travis under our forks to share in PRs. What kind of test pages would we like to see used?

[priley86]

Any thoughts on react-docgen as opposed to using jsdocs ?

[priley86]

It looks like react-storybook-addon-info supports react-docgen comments in our components. Still awaiting this upstream PR to be merged...
storybook-eol/react-storybook-addon-info#122

[priley86]

Referencing #37 : this has now been resolved in Storybook 3.