react-primitives icon indicating copy to clipboard operation
react-primitives copied to clipboard

Add docs site

Open lelandrichardson opened this issue 8 years ago • 7 comments

lelandrichardson avatar Dec 23 '16 19:12 lelandrichardson

Hey! I'd love to make documentation/examples for react-primitives. Is there any place that you think would be a good place to start?

Ronolibert avatar Aug 24 '17 03:08 Ronolibert

Hey there is this still use and how can one contribute :) Thanks

code4cake avatar Apr 17 '19 13:04 code4cake

Might be worth discussing with @brodybits who was planning on writing more docs soon

mathieudutour avatar Apr 17 '19 14:04 mathieudutour

@mathieudutour is there other way I could contribute? Thanks and cheers

Another question, could I use this in conjunction with react-styleguidist?

code4cake avatar Apr 18 '19 05:04 code4cake

Hi @dantesolis, my apologies for the delay. I think you should feel free to contribute a proposal as you see to be the best fit.

One thing that I think is really missing is clear documentation of the two types of extensions I recently learned about, as I reported in #136. I would be happy to contribute this but do not want to make any promises due to some other priorities.

I would also like to say that there seems to be a number of excellent JavaScript documentation frameworks available and I have not taken much time to evaluate or even properly track all of them. RNW (react-native-web) seems to link to a few nice ones. I think it would be ideal if the doc site would be static and could be hosted from GitHub.

I would favor adding storybook, like RNW did ([1]), and maybe adding expobook, react-styleguidist looks nice as well.

[1] https://github.com/necolas/react-native-web/tree/master/packages/website

brody4hire avatar Apr 19 '19 19:04 brody4hire

Hey @brodybits ok I think the first thing to do, would just to create a "Contribute" section on the project explaining the details. I'll be more than happy to tackle that as well as the react-styleguidist and/or the storybook example. I'll take a look during the weekend.

code4cake avatar Apr 23 '19 18:04 code4cake

Hey just fyi, still working on this, should be sending a PR by the end of the week.

code4cake avatar May 27 '19 12:05 code4cake