Rewrite the docs #289
Closed
Rewrite the docs #289
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
New README is up: https://github.com/gaearon/redux/tree/rewrite-docs |
Closed
JSDoc improvements for applyMiddleware Update API.md with improvements of createStore doc JSdoc tweaks Adjustments based on review Typos Correctly define jsdoc param args Typo
JSDoc improvements
I find this ordering to be more clear IMO. I'm fine with this PR getting rejected =P
Update ordering or things
Grammar fix
Fix links in Getting Started docs
Gitbook for static documentation website (#311)
Closed
|
This is superseded by #349. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In this branch I'll be rewriting the docs from scratch against the 1.0 branch.
I'm going to gradually pick JSDoc annotations and the new docs from #140 but I wanted to start with a clean slate because having a mix of the old and the new docs in the same place puts me into a creative block.
I'm going to start with README (I already have a few paragraphs there). We won't be able to make a static website ahead of the release, so I'll focus on the README + a
docsfolder with the docs in Markdown.