marklogicworkflow icon indicating copy to clipboard operation
marklogicworkflow copied to clipboard

Review and update documentation

Open eouthwaite opened this issue 6 years ago • 3 comments

This is something of a catch-all to replace #83 as we are not following the original sprints

Would we be better off moving the documentation out of the code and into the Wiki tab?

eouthwaite avatar May 08 '19 21:05 eouthwaite

From #82 : Ensure all 'how it works' documentation reflects how it has ended up working. Ensure all steps are covered in STEPS.md Ensure complex tasks are documented in documentation/features with their own documentation Update install guide for changes (especially security)

eouthwaite avatar May 08 '19 22:05 eouthwaite

also relates to #141

eouthwaite avatar May 08 '19 22:05 eouthwaite

RESTAPI.md would be better if more like swagger documentation with example payloads and results

eouthwaite avatar Jun 05 '19 07:06 eouthwaite