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

Docs - add RTK Query content to Getting Started page #1066

Conversation

Shrugsy
Copy link
Collaborator

@Shrugsy Shrugsy commented May 18, 2021

Related to #964

Adds some additional detail regarding RTK Query to the 'Getting Started' page

@codesandbox-ci
Copy link

codesandbox-ci bot commented May 18, 2021

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 5c5a2f8:

Sandbox Source
Vanilla Configuration
Vanilla Typescript Configuration
rsk-github-issues-example Configuration

@markerikson
Copy link
Collaborator

Netlify build is failing due to busted links:

9:00:15 AM: Exhaustive list of all broken links found:
9:00:15 AM: 
9:00:15 AM: - On source page path = /introduction/getting-started:
9:00:15 AM:    -> linking to ./getting-started-rtk-query.mdx (resolved as: /introduction/getting-started-rtk-query.mdx)

@markerikson
Copy link
Collaborator

Hmm. I know I had a couple vague thoughts in my head for what an "Overview" page would contain, but I'm not sure what those were atm. I think I was picturing something that was more of a cross between the "RTKQ Tutorial" page and a "why should we do this data fetching stuff via RTKQ anyway?" writeup.

I don't think this is quite what I was picturing, but it's good material anyway.

I'd actually suggest we just consolidate the RTKQ-specific content here into the existing "Getting Started" page as an additional section - no need to repeat all the install info.

@Shrugsy
Copy link
Collaborator Author

Shrugsy commented May 18, 2021

I'd actually suggest we just consolidate the RTKQ-specific content here into the existing "Getting Started" page as an additional section - no need to repeat all the install info.

That's a good idea, I'll change it up like that

@Shrugsy Shrugsy marked this pull request as draft May 18, 2021 15:03
@Shrugsy Shrugsy changed the title Docs - add Getting Started With RTK Query page [WIP] Docs - add RTK Query content to Getting Started page May 18, 2021
@netlify
Copy link

netlify bot commented May 18, 2021

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

Built with commit 2137aeb

https://deploy-preview-1066--redux-starter-kit-docs.netlify.app

@netlify
Copy link

netlify bot commented May 18, 2021

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

Built with commit 2137aeb

https://deploy-preview-1066--redux-starter-kit-docs.netlify.app

@netlify
Copy link

netlify bot commented May 18, 2021

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

Built with commit 5c5a2f8

https://deploy-preview-1066--redux-starter-kit-docs.netlify.app

@Shrugsy Shrugsy marked this pull request as ready for review May 18, 2021 15:20
@Shrugsy Shrugsy changed the title [WIP] Docs - add RTK Query content to Getting Started page Docs - add RTK Query content to Getting Started page May 18, 2021
@markerikson
Copy link
Collaborator

Looks better! Not sure "Installation" is the right word for that header, since we're not actually installing anything. Can't come up with a good alternate header phrase atm - maybe just drop that "Installation" header entirely and have that code block be directly after the preceding couple of paragraphs?

@Shrugsy
Copy link
Collaborator Author

Shrugsy commented May 18, 2021

Looks better! Not sure "Installation" is the right word for that header, since we're not actually installing anything. Can't come up with a good alternate header phrase atm - maybe just drop that "Installation" header entirely and have that code block be directly after the preceding couple of paragraphs?

Ah, I had the same reservations as you trying to come up with a more accurate header, but didn't even consider "no header" as an option. I was thinking it was roughly accurate in the sense that it is "here is how to install: it's already installed". But forgoing the header is definitely better

@markerikson
Copy link
Collaborator

LGTM!

I do plan on doing a typos/editing pass over the docs before release, so I'm not doing much review on those atm.

@markerikson markerikson merged commit ea12adc into reduxjs:feature/v1.6-integration May 22, 2021
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.

2 participants