Comprehensive, web-based documentation
Opened this issue · 12 comments
I spent today setting up an instance of ContraxSuite in a VM and I must admit that the documentation appears a bit patchy and the collection of PDF files is slightly confusing at times. Maybe it's worth considering to use some web-based documentation such as readthedocs, Gitbook or the Github Wiki? Maybe that's something I could contribute to.
Thank you, @alexanderjulmer! We are working hard to improve the documentation and appreciate any feedback you can provide as you work through the install process. It is definitely a work in progress :)
Web-based documentation is on our roadmap, but we have not selected a documentation framework yet for this purpose. We have a number of audiences to cover, including:
- End Users: upload documents, review documents, visualize/generate reports, interact with UI, etc.
- System Administrators: install, monitor, and manage CX instances
- Developers and Implementers: build new models or languages, customize workflows or integrations, etc.
Which group do you think you'd fall into, and what documentation frameworks do you like most? We are considering RTD, Sphinx, and GH Wiki, but are open to other ideas.
I guess 'implementer' would be the best fit. I am mostly exploring and evaluating different legal technology products but I would also like to contribute to the development within the limits of my abilities.
I don't have a preference as to documentation frameworks but maybe GH Wiki is a good place to start and keep everything together on GitHub.
Could you maybe make the source files of the pdf manuals available? That would make writing the docs a bit easier.
Hello @alexanderjulmer, these are currently Google Docs files hosted internally on our domain. For security reasons, we cannot share or collaborate on documents outside of our domain unless you are on an authorized client domain :)
We are finalizing our release for the end of month, but will get someone working to convert our Google Docs to a more "portable" format ASAP. Worst case, are you able to use MS Word?
@mjbommar, I can certainly work with Word files, but really any format is fine. Shall we start with Github Wiki? Nice presentation in Frankfurt yesterday, by the way.
Happy to help with this as well, and equally ambivalent to the format. I suppose the best one would be the most re-usable; some format which could be used to generate both HTML and PDF output.
Until something more strategic is identified, would you accept pull requests for transcriptions of your PDFs into Markdown? Of course don't want to do any wasted work if a more sustainable solution is in sight, but also keen to "just get started!"
I can also help with this. For example, a simple walk-thru on training the text unit classification on the sample data such that the "Assistant" tab shows recommendations would be very beneficial.
I have successfully installed the product on a VM. Is there any "Getting Started" document (even if it is WIP) to start with the web UI ? To start with on what port is the UI deployed ?? :-)
Is there some sort of slide deck or site with various screenshots of the sample reports, UI, usage, etc?
There seems to be no demo videos, no screenshots, or any sort of images showing what the application and reports can do.
@StephenOTT - were updating our materials in this area. Please send us an email at support@lexpredict.com and we can help out.
Thanks,
Eric
Let me know if I can help. I will email support above and describe my skill set to see if I would be a good fit to contribute.
https://github.com/LexPredict/lexpredict-contraxsuite/tree/master/documentation contains links to the lexpredict-contraxsuite-services repo which seems to no longer exist.