Closed elsalahy closed 2 years ago
Summary:
We need to add documentation and description for each application in app folder
Why do we need this?
So that the users can understand the functionality of each app and how to use it properly.
What is already there? What do you see now?
A simple line per app description here
What is missing? What do you want to see?
A README.md for each application and a description of the application behavior and usage.
How do you propose to implement this?
Each application should implement the following template:
Environment:
All (bare-metal and os based)
Acceptance Criteria:
None
What can you do yourself and what do you need help with?
These docs are exhausting and need to be split between us.
@marnixcro please write the documentation as described above on the following apps
@elsalahy will take on
Please note that the same documentation will be used on the website www.genericnode.com/docs
Summary:
We need to add documentation and description for each application in app folder
Why do we need this?
So that the users can understand the functionality of each app and how to use it properly.
What is already there? What do you see now?
A simple line per app description here
What is missing? What do you want to see?
A README.md for each application and a description of the application behavior and usage.
How do you propose to implement this?
Each application should implement the following template:
Environment:
All (bare-metal and os based)
Acceptance Criteria:
None
What can you do yourself and what do you need help with?
These docs are exhausting and need to be split between us.
@marnixcro please write the documentation as described above on the following apps
@elsalahy will take on
Please note that the same documentation will be used on the website www.genericnode.com/docs