You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The Context:
At the current status, the project documentation is fragmented in different places and it's hard to get what you're looking for. For example the README.md contains part pertaining to contributors, and the CONTRIBUTING.md contains part that do pertain to the end-user.
The Solution:
One way to solve this would be to funnel all the information that pertains to Developers/Contributors into the CONTRIBUTING.md and the information pertaining the end-user/customer into the README.md.
This although is not enough, there should be a docs folder re-organization that would accommodate the documentation of addons-per-flavor that we are going to provide in the future. This change should be easy to maintain yet powerful enough to make room for this.
The end goal is to reduce the cognitive load on either contributors or end-users that want to use this project.
The Alternatives:
No alternatives have been considered, but new ideas are welcome.
The text was updated successfully, but these errors were encountered:
Issue Type
Chore
Description
The Context:
At the current status, the project documentation is fragmented in different places and it's hard to get what you're looking for. For example the README.md contains part pertaining to contributors, and the CONTRIBUTING.md contains part that do pertain to the end-user.
The Solution:
One way to solve this would be to funnel all the information that pertains to Developers/Contributors into the CONTRIBUTING.md and the information pertaining the end-user/customer into the README.md.
This although is not enough, there should be a docs folder re-organization that would accommodate the documentation of addons-per-flavor that we are going to provide in the future. This change should be easy to maintain yet powerful enough to make room for this.
The end goal is to reduce the cognitive load on either contributors or end-users that want to use this project.
The Alternatives:
No alternatives have been considered, but new ideas are welcome.
The text was updated successfully, but these errors were encountered: