Technical documentation for the SDR should be produced, this should stem from the project's README file and link to more detailed help and guides. In our 2022-11-26 project meeting we agreed to adopt the diataxis style for documentation.
This is our current documentation to do list:
Tutorials
[ ] #113
How tos
[x] #114
[ ] #117
[x] #118
[x] #116
[ ] #115
[ ] #123
Explanation pieces
[ ] #124
[x] #125
[ ] #126
[ ] #127
[ ] #119
[ ] #120
[x] #129
References
[x] #121
[x] #122
[ ] #128
Please let me know if you have suggestions for more documents and I will add them to this list. Additionally please give me your thoughts about the use of the diataxis framework.
llivermore
commented
2 years ago
Technical documentation for the SDR should be produced, this should stem from the project's README file and link to more detailed help and guides. In our 2022-11-26 project meeting we agreed to adopt the diataxis style for documentation.
This is our current documentation to do list:
Tutorials
How tos
Explanation pieces
References
Please let me know if you have suggestions for more documents and I will add them to this list. Additionally please give me your thoughts about the use of the diataxis framework.