Skip to content
New issue

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

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

Already on GitHub? # to your account

Update Docs #14

Merged
merged 1 commit into from
Jul 31, 2015
Merged

Update Docs #14

merged 1 commit into from
Jul 31, 2015

Conversation

jlogsdon
Copy link
Contributor

Here's my proposed structure for the documentation. I'm including the original docs from Redux for reference as I move forward. The very top should have a brief "quick start" example, and the sub sections will go into more detail about each.

@gaearon
Copy link
Contributor

gaearon commented Jul 30, 2015

This looks good to me.

@jlogsdon
Copy link
Contributor Author

Cool. I will work on filling out all the sections today/tomorrow.

@gaearon
Copy link
Contributor

gaearon commented Jul 30, 2015

Thanks, I really appreciate it.

@Keats
Copy link

Keats commented Jul 31, 2015

@jlogsdon don't forget to look at #1 and #16 so you don't write documentations for something that's going to be removed/changed

@gaearon
Copy link
Contributor

gaearon commented Jul 31, 2015

@Keats @jlogsdon

While #1 and #16 are important, it's more important to document the existing APIs right. I'm releasing Redux 1.0 very soon, and I'm going to have examples using React Redux 0.2.1. When we figure #16 out, we'll rewrite the docs, but it might take another week or so. Documenting 0.2.1 is still very important because lots of projects depend on it.

@jlogsdon
Copy link
Contributor Author

Thanks for pointing those out, but I am going to focus on the existing API for the reasons @gaearon said. The new API isn't quite ready, and having docs of the stable release will be very important for the Redux 1.0 release.

I'm working on expanding some of the sections right now and will have something to push up here today.

@jlogsdon
Copy link
Contributor Author

Here we go. The "Child must be a function" section needs to be expanded, but I am not familiar enough with the issue myself and couldn't find any resources about it specifically. If I can get pointed to either the React issue or a fiddle showing the issue I can fill that part out.

gaearon added a commit that referenced this pull request Jul 31, 2015
@gaearon gaearon merged commit 4cb7e83 into reduxjs:master Jul 31, 2015
@gaearon
Copy link
Contributor

gaearon commented Jul 31, 2015

Awesome, thanks.

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

Successfully merging this pull request may close these issues.

3 participants