where shall we document component usage about octagon

[cdaringe]

this would be toooo raaaad, storybookjs/storybook#602

[eddier]

Depending on the timeline for the above script we could use the doc-gen plugin to provide some the configuration options available to components. https://github.com/kadira-samples/react-storybook-docgen-info-sample

[eddier]

Alternatively is storybook providing any advantage compared to using Styleguidist exclusively?

[eddier]

@cdaringe this is an example of one of the existing custom components using the Styleguidist approach - if you want to check out how this might work in practice I can check this branch in.

[cdaringe]

hey @eddier, that looks saweeeet. very interested! lets try it youre down!

[cdaringe]

sorry for the lagged responses again, FYI. busy day!

[eddier]

It's on the styleguide branch, check it out and install dependencies then yarn run styleguide. Let me know what you think.

Still pretty experimental so let me know if you hit any issues!

[cdaringe]

it launched & ran great! lets discuss paths forward. i see a few options.

• no storybook, just styleguidist.
  • this ostracizes UX, who is a first class customer & needs viz as the lib changes
    • i.e. there isnt a "storybook-hub" tool for styleguidist to integrate them into the reviews easily
• no styleguidist, just storybook
  • lose out on interactivity & rich API docs
    • those API docs are too good to lose!
  • still could benefit from the component docs because of https://github.com/kadirahq/babel-plugin-react-docgen
• use both
  • still get the benefits of both, but have a duplicate build temporarily to serve developers

im in favor of using both (option 3), with the intent to drop the standalone styleguidist in the high hopes that the storybook integration becomes a thing™.

thoughts? @Tripwire/octagonners @jhegg

[cdaringe]

@eddier , undefineds are a little strange

$ yarn run styleguide
yarn run v0.21.0
$ styleguidist server
Style guide server started at:
http://localhost:3000


src/styles/components/pagination-control.css
undefined [undefined]


src/styles/components/favorite-button.css
undefined [undefined]


src/styles/app.css
undefined [undefined]
undefined [undefined]
undefined [undefined]
undefined [undefined]

Compiled successfully!

[eddier]

Yeah I figured we make a call on direction then we iron out any issues with the selected approach assuming it includes styleguidist.

[jhegg]

im in favor of using both (option 3), with the intent to drop the standalone styleguidist in the high hopes that the storybook integration becomes a thing™.

That sounds like a good plan to me.

[eddier]

Sounds good. I've updated that branch with the following:

• Section for custom components

  • examples are automatically tracked as '.examples.md'

• Section for SUI based components

  • examples are tracked in the /styleguide/.examples.md'
  • examples have to be manually entered which is probably ok given that there are not a ton and not all SUI components should be included in this, only extended ones.

[cdaringe]

merged!