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

Add "Usage with TypeScript" section to the docs #267

Merged
merged 3 commits into from
Dec 1, 2019

Conversation

phryneas
Copy link
Member

@phryneas phryneas commented Dec 1, 2019

I believe this should cover most of the "usage with TS" stuff (including the changes from #262).

But writing docs is not my strong suit, so I'm looking for feedback :)

Closes #264

@netlify
Copy link

netlify bot commented Dec 1, 2019

Deploy preview for redux-starter-kit-docs ready!

Built with commit 8afcecf

https://deploy-preview-267--redux-starter-kit-docs.netlify.com

@codesandbox-ci
Copy link

codesandbox-ci bot commented Dec 1, 2019

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 8afcecf:

Sandbox Source
sharp-curie-iccik Configuration
epic-platform-xblxs Configuration
rsk-github-issues-example Configuration
RTK-TS-Documentation Issue #264

@phryneas phryneas force-pushed the typescript-docs branch 2 times, most recently from e093ae4 to 456eabb Compare December 1, 2019 17:54
@phryneas
Copy link
Member Author

phryneas commented Dec 1, 2019

On a sidenote, @markerikson - the generated netlify urls still say "redux-starter-kit" :D

Copy link
Collaborator

@markerikson markerikson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fairly good overall. Nitpicks are mostly grammar, casing, formatting.

docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
docs/usage/with-typescript.md Outdated Show resolved Hide resolved
@markerikson
Copy link
Collaborator

@phryneas : yeah, I know :) that's because the actual Netlify site name is redux-starter-kit-docs.netlify.com, and both DNS entries point to that. It could be changed, but we'd have to do more coordinating with the js.org folks, and it's really not worth the effort at this point.

@markerikson
Copy link
Collaborator

Format it with Prettier, that's causing the CI failures.

@phryneas
Copy link
Member Author

phryneas commented Dec 1, 2019

Argh xD
I just disabled prettier because I was reviewing a project written without prettier. I thought I did so on project-level :D

@phryneas
Copy link
Member Author

phryneas commented Dec 1, 2019

Okay, I think I got all your comments. Thanks for the thorough review!

@markerikson markerikson merged commit 92691e7 into reduxjs:master Dec 1, 2019
@markerikson
Copy link
Collaborator

Great, thanks!

Per my comment in #262 , can you go ahead and add a bit of info to the createReducer and createSlice docs to cover the builder API?

@le0nik
Copy link
Contributor

le0nik commented Dec 1, 2019

It's builder.add in docs, but builder.addCase in code and builder types. Which one should be used?

@markerikson
Copy link
Collaborator

@le0nik: whatever the code says :) can you file a PR to fix the docs?

@le0nik
Copy link
Contributor

le0nik commented Dec 1, 2019

@markerikson done #269

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

Successfully merging this pull request may close these issues.

Add a "Usage with TypeScript" docs page
3 participants