SPlanzer
commented
4 years ago Read me looks good and there is no work to do upfront prior to starting the project. The pull request template forces consideration of readme updates and as tasks are complete the readme will be updated
For example, the porting task will see Qt4 references replaces with Qt5 and GitHub actions tasks will see the build badge added.
It does however raise the need of a documentation sprint.
- Dev notes are down in
/src/NZGBplugin/help/devnotes.html- Standard practice is to include these in a readme.md or confluence
- User documentation is down in
/src/NZGBplugin/help/index.html- LI now tends to place user docs in confluence. It should be considered if this is in scope?
Discussion required:
Is document migration to confluence in scope?
ensure read me is complete
...more to come