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

Improve READMEs of each folder #54

Open
mateosss opened this issue Oct 11, 2020 · 1 comment
Open

Improve READMEs of each folder #54

mateosss opened this issue Oct 11, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@mateosss
Copy link
Owner

mateosss commented Oct 11, 2020

Matter folder structure is more or less preserved on install even though some folders don't have more than a README file. The idea behind this is that a curious user or potential contributors can read right from the repo what each folder is supposed to contain and get an idea of how Matter works in the process.

If you've been reading the project and think you can improve the description of some area that you found particularly weird, go ahead and submit a PR, hopefully it will make it easier for future readers.

@mateosss mateosss added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers Hacktoberfest labels Oct 11, 2020
@Niaz-Ul-Haque
Copy link

Niaz-Ul-Haque commented Oct 11, 2020

I think having "Uninstall" early on is not a good idea. If it's at the end of the Usage category, it will be better. If it's at the last, even better. And I can also see that there is a total of 9 examples, I think it's too many examples and people who rush through the readme (most people) will probably go till 4 - 5 examples max.

If you think I am making some sense, please do assign me this issue and I'll try to make it better as much as possible from my side.

(These are just my opinions and what I think of the readme.)

Thank you!

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants