protean
protean copied to clipboard
docathon - overhaul documentation for 0.12.0+
- streamline getting started - choose a methodology where a bundled sim is not used
- consolidate over sample-petstore and petstore-demo (they seem to be almost the same thing barring a sim extension)
- add versioning to documentation
Plan:
- reduce number of sample and tutorial codex files to a well maintained minimum number (full featured)
- use these to test protean itself preferable integration style see testathon ticket
- use comments in the codex files rather than doc explanations
- link to these from README and docs etc
- add a glossary to the documentation page for concepts
ensure we have good coverage of Proteans capabilities, i.e. matrix params etc