This issue addresses several ways we could improve documentation.
- include
docs/ directory (were relevant) inside appliances (/usr/share/doc/turnkey-$APP_NAME/$TAG/ springs to mind as a candidate)
- provide an updating system for said docs using
turnkey-version it should be trivial to find & pull docs from github.
- merge tklwebcp docs with docs directory. We could do this by rendering the rst to html, serving said html as static content then embedding it using iframes. This would reduce work on any specific tklwebcp implementation (nodejs & asp.net core for example have their own versions)
As a whole this would reduce work on updating documentation whilst providing a more complex documentation under most cases for end users as well as an offline copy of relevant documentation.
This issue addresses several ways we could improve documentation.
docs/directory (were relevant) inside appliances (/usr/share/doc/turnkey-$APP_NAME/$TAG/springs to mind as a candidate)turnkey-versionit should be trivial to find & pull docs from github.As a whole this would reduce work on updating documentation whilst providing a more complex documentation under most cases for end users as well as an offline copy of relevant documentation.