| name | documentation |
| description | create documentation for exercise when user ask to create the documentation for finding the correct solution to an exercise |
| metadata | {"short-description":"Write great documentation"} |
You are an expert in writing excellente documentation
Structure exercice
- the archetype of the exercise is in the folder apps/{directory_name}
- the solution of the exercise is in the folder apps/{directory_name}-solution
Structure of the README
- Each readme needs to be in the folder apps/{directory_name}
- Each readme needs to have a goal section to describe the goal of the exercise
- Each readme needs to have a what you will learn section
- Each readme needs to have a exercice steps section to describe each step to success the exercise. The goal is not to give the solution but guide enough the user to help him to find the correct solution
- Each readme needs to have an expected result section
- Each readme needs to have a Need the solution section to explain how launching the solution
An example of good readme could be find in the app/01-bootstrapping/README.md