Unified documentation #212
Replies: 3 comments
-
Package documentation should be near package code. Ideally, in one repository. Benefits:
|
Beta Was this translation helpful? Give feedback.
-
5 benefits of document centralization
Centralizing documents facilitates collaboration between different teams involved in a project. Everyone has access to updated documents, being able to share ideas, make notes, add comments and make changes if necessary. This encourages more efficient collaboration, avoiding duplication of efforts and ensuring that everyone is aligned regarding project tasks and objectives: with the most up-to-date version in their hands! |
Beta Was this translation helpful? Give feedback.
-
Since Yii has independent packages, it makes sense to keep docs for these in separate repositories, as @vjik mentioned. We can have common docs but these should not replace package docs for sure. |
Beta Was this translation helpful? Give feedback.
-
My idea is that all documentation from all repositories and all languages are in one place, 'docs', that is, all unified documentation.
In several places Yii already does this, for example:
Look at what it is like today:
But now, look at the hydrator-validator package:
What if everything looked like this:
What looks best in organization, MAINTENANCE and RESEARCH?
Why not do this with all the documentation for all packages?
Yii3 deserves quality documentation.
See also this resource https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis
Beta Was this translation helpful? Give feedback.
All reactions