-
Notifications
You must be signed in to change notification settings - Fork 91
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
Restructure Readme to more of a tree like approach #734
Comments
I suggest that we clean up the main README.md and create topic specific files in the docs folder. The main readme should aim to clearly communicate what this project is about and how people can quickly start playing with it. Some suggestions:
|
May I work on this issue? |
Hi @anshikavashistha, yes please give it a try. |
@mbrandenburger Agreed with you. We should only mention some introductory part in the README.md and rest of the content should be moved to docs folder as you have mentioned.
|
@mbrandenburger We could create dedicated Files in
|
@munapower could you please guide @anshikavashistha with this issue. thanks |
@anshikavashistha could you add here an outline of what we currently have in the readme? Something like:
|
Is your feature request related to a problem? Please describe.
Currently the beginner is prompted with all the information all at once and this could lead to confusion. A user-friendly approach could be to add the required information in each readme in each branch.
Describe the solution you'd like
Subdividing the readme into sections that are mentioned in the main but are documented in the branch that they are linked to.
Describe alternatives you've considered
Additional context
The text was updated successfully, but these errors were encountered: