One thing I’ve changed my mind on when it comes to documentation is whether to discuss implementation details.
The purist in me wanted to leave them out because “the whole point is you don’t need to know!”
But in hindsight this paternalises consumers. It leaves them without a good mental model.
The purist in me wanted to leave them out because “the whole point is you don’t need to know!”
But in hindsight this paternalises consumers. It leaves them without a good mental model.
Comments
Mostly coz I'm tired of answering the same questions over and over again in the Discord 😅
- when loaders are called, when "revalidation" happens
- loaders<->sessionStorage, or generally how to work with state when it's not in the URL
- pairing with something like AGGrid server-side row model
- non-trivial testing examples, when to rely on msw vs createRoutesStub
https://blog.isquaredsoftware.com/2020/05/blogged-answers-a-mostly-complete-guide-to-react-rendering-behavior/
I don’t think it’s worth the trade off though. Knowing implementation details gives you more confidence to build on top, lets you better understand what’s possible, and gives you more context when debugging.
Like how a class implements an interface.