docs: Update caveats for React cache documentation #8192
Conversation
Clarify cache behavior and limitations in React.
|
Hi @aloeugene! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
Size changes📦 Next.js Bundle Analysis for react-devThis analysis was generated by the Next.js Bundle Analysis action. 🤖 This PR introduced no changes to the JavaScript bundle! 🙌 |
|
Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks! |
1 participant
TLDR: This MR adds a brief mention of the behavior of
cachefunction right at the top of the documentation, in the "Caveats" section, which feels like the right place for such "heads up, confirm you're using it right" piece of information.Recently we were working on enhancing reliability for our website, specifically revisiting what and how efficiently we are caching.
After a bunch of investigations and trying things out, we found out that we were not using the
cachefunction correctly. It was added some time ago and we were passing objects in params instead of primitives. But since the documentation doesn't really directly mentions it anywhere (only deep down in the troubleshooting section, where it mentionsObject.iscomparison briefly without explaining it too much), we didn't even know we are using it wrong until we started targeted debugging.This whole investigation and debugging flow sparked some ideas and we wanted to help future engineers like ourselves to not end up in a similar situation by misreading/misunderstanding the documentation. So this MR adds a brief mention of the behavior of
cachefunction right at the top of the documentation, in the "Caveats" section, which feels like the right place for such "heads up, confirm you're using it right" piece of information.