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

proof reading documentation #8

Open
iamstarkov opened this issue Jun 11, 2017 · 1 comment
Open

proof reading documentation #8

iamstarkov opened this issue Jun 11, 2017 · 1 comment

Comments

@iamstarkov
Copy link
Member

there are two problems:

  • docs might have typos and grammar mistakes, because English is not my native language
  • docs might have logic flaws and be unintuitive for other developers_, because I am knee deep in this project, so I understand everything and it seems easy for me, so I struggle to understand what is missing in documentation.

So I need help from native speakers and from developers who are new to this project

@GertSallaerts
Copy link
Collaborator

GertSallaerts commented Jun 13, 2017

Personally I would reduce/remove the entire motivation section. My thoughts are, just tell people something like

withTheme makes sure your theme is always available and up to date for the component it wraps. It does not matter how far down the React tree it is, nor does it matter if you use PureComponent or other ways of update blocking in between, the theme will always be available and up to date.

I'd remove all the extra information about context etc. Because it's like you say, users should not have to worry about context, that's up to library owners. We just promise them it works, they don't need to worry their heads about whether or not we're using context.

Anyway, that's just my personal opinion on the subject. What are your thoughts?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants