2023-05-09 13:47:14 -04:00
|
|
|
|
# Documentation Guidelines
|
|
|
|
|
|
|
|
|
|
- ## ⚠️Keep it organized and structured⚠️
|
|
|
|
|
- For new features, create new documents and place them in the appropriate folder(s)
|
|
|
|
|
- When you create a new document, do not forget to add it to the table of content
|
2023-06-06 07:44:53 -04:00
|
|
|
|
- Add a shortcut that point back to the [README.MD](../../README.md) in the bottom of new documents (look at other docs for example)
|
|
|
|
|
- Use `#` / `##` / `###` for the different section of the doc
|
2023-05-09 13:47:14 -04:00
|
|
|
|
- Do not add unrelated information to an existing document, create a new one if needed
|
|
|
|
|
- For incremental updates, you need to update the main **README.MD** and **CHANGELOG.MD**
|
|
|
|
|
- In the main README update the part where the last version is shown and the features section if needed
|
|
|
|
|
|
|
|
|
|
##
|
|
|
|
|
|
|
|
|
|
## [Go Back to ReadMe](../../README.md)
|