jambor.pro/docs-onboarding
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update: Improve onboarding documentation and include lessons learned from customer projects.

Browse source
This commit is contained in:
Jan Jambor 2024-05-14 17:12:01 +02:00
parent 439f90cbff
commit 1592680085
5 changed files with 38 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

4
documentation-guidelines.md
View file

@ -2,6 +2,10 @@
Best practices and guidelines for writing code documentation.
## Formats
All documentation should be easy maintain and accessible. Easy formats should be preffered over more complex ones.
## Release Notes
The idea is to get rather automated release notes. To have this as easy as possible, we need: