oc icon indicating copy to clipboard operation
oc copied to clipboard

OC-Client setup documentation

Open nickbalestra opened this issue 8 years ago • 4 comments

Improve documentation related to adding the oc-client.js library via the oc-client componnet. @kmcrawford had some issue understanding the workflow and how to configure that scenario, feel free to add some extra context on what wasn't clear so that we can improve the documentation on that.

nickbalestra avatar Oct 06 '17 13:10 nickbalestra

All the documentation of the project is stored in the github wiki? I think we should do something about that too.

elboletaire avatar Nov 28 '17 11:11 elboletaire

Yes, what would you suggest?

nickbalestra avatar Nov 28 '17 11:11 nickbalestra

I think github wikis never worked too well, everyone usually moves to use something like gh-pages (with a custom static built page), or services like readthedocs.io. In fact, we could even use both. Use gh-pages for the pretty version publishing the product and the documentation in readthedocs.io.

Or even having everything in gh-pages well packaged (both the "product page" + the documentation)... I don't know, are just ideas.

elboletaire avatar Nov 28 '17 11:11 elboletaire

@nickbalestra hi there :) we're looking at using OC for a large project at rocket lawyer (and loving bits of it!), but the lack of documentation is a significant hurdle to adoption -- is there a plan for more detailed documentation?

jackbush-rl avatar Nov 08 '18 11:11 jackbush-rl