-
Notifications
You must be signed in to change notification settings - Fork 123
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
OC-Client setup documentation #698
Comments
All the documentation of the project is stored in the github wiki? I think we should do something about that too. |
Yes, what would you suggest? |
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. |
@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? |
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.
The text was updated successfully, but these errors were encountered: