Frontend Documentation
Where we are and where we want to be
Goal
We would like to have a centralized place for most of the FE documentation, additional documentation could be linked up.
New developers (or devs who have not worked with our stack) should be able to run the apps and contribute by looking at the docs.
Current docs
Our current documentation is spread across multiple platforms
- Confluence
- GitHub Wiki
- GitHub README.md
- ...
Our proposal
We propose to have as much documentation as possible in GitHub README.md files. Beginning with the main README.md on the root level, which would be an overview of our project, linking to each project's individual README.md file.
On top of that, we would have more documentation in the "/doc" folder with things like a contribution guide and other global documentation.
Also a guideline of what should be documented where (some things would belong on confluence and would be linked in our README.md files)
- Version controlled
- Reviewable
- Searchable
- Offline availability
- Viewable in IDE's
- Integratable with Mermaid (Diagramming & charting)
Pro's
Con's
- Pull request required
- Images will to static
- Need GH access
Thank You!
Questions?
Palette
By Sam De Maeyer
