Question about document

[praneybehl]

Hey Jared,

The package look awesome, some great work here.
I can see that there is some signs of docs but looking into the package.json file I don't see a script to build the docs.

Could you please advise how to build the docs for the components?
Would also love to contribute if possible.

Cheers

[jaredLunde]

Hi Praney,

The docs are a work in progress! I started work on a docs site here: https://github.com/jaredLunde/curls-app

As you can see by the last commit date I haven't moved on it in a while and the build is current failing. Knowing that other people have looked at the project is motivating so I will spend some nights this week getting my ducks in a row.

My big concern earlier in the year was that I hadn't written any production apps with it but that has changed now that I have several under my belt.

If you would like to follow along with the progress, I have just created a roadmap to v1 here: https://github.com/jaredLunde/styled-curls/projects

As far as contributing goes, I can fill you in on the patterns I've been using and some of the challenges I'm encountering if you want to have a conversation about that sometime. Perhaps there are things I could be doing better. At the moment my main concern is just fixing the docs site build and getting it live.

Thanks for taking an interest in the project! I'll update here when I fix that build.

[praneybehl]

Hey Jared,

Thanks for coming back so quickly. I tried the curl-app but the build fails, tried spending an hour trying to fix missing dependencies and npm packages, but could it be that you might have been using local packages that are different than those in the config?

Would you like to consider something like storybook or react-styleguidist for the docs I could help out with it.

It would be great to catch up sometime, I am down-under in Melbourne Australia GMT+10, not sure what time zone you are in. I could be reached with my username various social sites or gmail if you would want to ping and then can setup up a suitable time.

Cheers,
Praney

[jaredLunde]

I did mention in my original comment that the curls-app build is failing. Sorry I didn't make it more clear as that would have saved you some time :( It's hard for me to diagnose because it was so long ago and it wasn't a part of my normal build process - was just tossing something together largely for the purpose of benchmarking direct function calls vs functional components. I'll set up a proper build environment early next week or Sunday night when I get back from the mountains.

I looked at storybook and react-styleguidist and at first glance react-styleguidist looks most desirable to me. In general I like the idea of most of the documentation coming from the code comments because you're killing two birds with one stone that way.

I'm in Mountain time so we've got 8 hours ahead of space between us as you're 16 hours ahead of me. I usually work daily between 9a-5p + 10p-12a MT.

My email is here: https://github.com/jaredLunde
Twitter: https://twitter.com/jaredLunde