How to Document
What should be documented
The most important thing is to define if something should be documented in this repository or in a specific project. In this case, the criteria for deciding is whether what is intended to be documented is cross-projects (general knowledge) or is something specific to a project.
Only documentation, information and cross-project knowledge should be included here. In addition, each project should have its particular documentation in its file structure, respecting the same file structure of this repository (or the most reasonable one, taking this structure as a model).
The documentation should not include information related to the use, implementation or how-to of libraries or technologies themselves, but rather how they are applied in the project or how they are used in GM2.
You can add links or references to libraries or technologies docs.
How to start documenting
To start documenting, just clone this repository, search in the file structure for the topic that is closest to your need and add there your *.md or .mdx file. If no folder matches your needs, one can be created. Once the doc is ready, create a pull request.
How to add graphs to md
The approach selected by GM2 is to install the Draw.io Integration extension to VSCode.
Then, you can simple create a *.drawio.png file in the desired folder. When clicking on the file, a draw.io tab will let you edit the diagram in VSCode.
In the .md or .mdx markdown file, include these images as normal.
e.g:
