[WIP] Document components using Docz

[fzaninotto]

Testing Docz for API doc generation.

• Make docz work
• Document a few components
• Tweak publish script to generate components doc alongside the existing doc

I'm not convinced that docz is finished. Some of the basic requirements aren't yet met, so I'll put this issue on pause until docz matures a bit.

[djhi]

Some of the basic requirements aren't yet met

Can you elaborate ?

[fzaninotto]

Out the top of my head:

• automated Props table don't work on our components (either because we export more than one component per file, or because we use HOCs, see Cannot render component through higher order component doczjs/docz#65) (react-docgen limitation) (so we write prop tables by hand)
• The <Playground> tag outputs its own code (Remove <Playground> from output in the Playground doczjs/docz#11)
• The <Playground> tag outputs context (Allow <Playground> inside elements doczjs/docz#75)
• The docs aren't mobile-friendly (Make docs generated responsive doczjs/docz#49)
• The default theme is too large (somehow mitigated in this PR)
• I'm missing an interactive playground (à la storybook knobs) (Allow users to edit the playground examples doczjs/docz#79)
• The default theme injects global styles that override the components styles (Default theme global styles change components look and feel doczjs/docz#80)

[ashim-kr-saha]

Definitely, we will get so much help with this kind of documentation. In the above example, I got some more clarity. +1

[brikou]

TS support with Docz is quite good, and automated Props table works as expected (default export is not required anymore, IProps signature is well parsed, just as Cmpt.defaultProps). You should give another try with newly converted TS components.

[fzaninotto]

The problem is we already have to migrate all ra-core to TypeScript to be able to migrate components. Wanna give us a hand?

[brikou]

@fzaninotto why not, I can work on a few files. I'll take a look this week-end 👍

[brikou]

After playing with Docz, I don't thing this is the right tool to build a robust documentation.
Why? Because of MDX and lack of TS support. Documentation cannot be checked by TS.

[fzaninotto]

This Pr is too old. If we ever generate API doc, we'll give Docz another try.