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

Improve Unstable Cache Docs #65942

Merged
merged 10 commits into from
Jul 1, 2024
Merged

Improve Unstable Cache Docs #65942

merged 10 commits into from
Jul 1, 2024

Conversation

Arinji2
Copy link
Contributor

@Arinji2 Arinji2 commented May 19, 2024

Unstable Cache has always had a very lacking documentation page, even though it adding its own new feature key parts . Its a normal occurrence for us in the NextJS Discord to see new people and more advanced users question what is the use of key parts, since the example in the docs. was very lacking.

I have made a few changes, like adding a much more functional example which showcases all the features of unstable cache, and also a small difference section between tags and key parts.

@Arinji2 Arinji2 requested review from a team as code owners May 19, 2024 04:52
@Arinji2 Arinji2 requested review from timeyoutakeit and leerob and removed request for a team May 19, 2024 04:52
@ijjk ijjk added the Documentation Related to Next.js' official documentation. label May 19, 2024
@chrisb2244
Copy link

Just a user, but a change to the docs like this (particularly the example added) looks like it illustrates the difference and a potential use case quite clearly.

I also agree that the current docs could use this kind of addition (how to best choose keyParts vs tags was not previously clear to me).

@Arinji2
Copy link
Contributor Author

Arinji2 commented May 19, 2024

Yup, we get a lot of questions regarding keyparts in the nexts discord ourselves :D
Nice to know you as a user also like the changes :)

Removed the extra keyParts vs tags differences, and instead modified the description for both.
@Arinji2 Arinji2 requested a review from leerob May 22, 2024 10:31
@swax
Copy link

swax commented Jun 17, 2024

Found this thread searching for unstable_cache keyparts on Google and it helped clear things up. Thanks.

leerob
leerob previously requested changes Jun 17, 2024
Copy link
Member

@leerob leerob left a comment

Choose a reason for hiding this comment

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

Let's make sure we run Prettier here so linting passes. Also, "Next.js" please and not "NextJS".

@Arinji2
Copy link
Contributor Author

Arinji2 commented Jun 20, 2024

Let's make sure we run Prettier here so linting passes. Also, "Next.js" please and not "NextJS".

Fixed the typos, i also ran pnpm prettier-fix but it didn't seem to do any changes which i could push with git. Any idea?

@samcx samcx requested a review from leerob June 20, 2024 08:10
@Arinji2 Arinji2 requested a review from samcx June 20, 2024 16:39
Copy link
Member

@samcx samcx left a comment

Choose a reason for hiding this comment

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

Thank you for submitting a PR!

:lgtm:

@samcx samcx dismissed leerob’s stale review July 1, 2024 11:50

Prettier'ing was handled!

@samcx samcx merged commit 303d155 into vercel:canary Jul 1, 2024
33 checks passed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Documentation Related to Next.js' official documentation. locked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants