Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] - Re-organize documentation structure for better readability #13

Open
julianxhokaxhiu opened this issue Jan 16, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@julianxhokaxhiu
Copy link
Member

julianxhokaxhiu commented Jan 16, 2023

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.

@julianxhokaxhiu julianxhokaxhiu added the documentation Improvements or additions to documentation label Jan 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant