Add version caveats for scroll-behavior docs #3427
Conversation
|
I say go ahead and retcon it to point to Really, that doc can be "upgrade-2.x.x.md" and is a living doc that changes to provide upgrade instructions for anyone coming from any previous major. The individual upgrade-2.x.0 docs can be differences for that particular minor. No point in checkpointing someone at 2.0, 2.1, etc etc if they can skip something like switching to scroll-behavior and then to react-router-scroll. |
|
That might be a better policy – living upgrade guides and all. I feel weird pointing users at something that requires v2.3.0 in the v2.0.0 upgrade guide, though. |
|
@timdorr Are you okay if we merge this as an improvement? Ideally we'll end up combining the nice parts of both @ryanflorence's scroll library and mine, and end up with something better later on. I don't think we need to tackle the question of whether our upgrade guides should be living documents (for how long?) just to add a caveat that the instructions in them no longer work with the latest release of the linked library. |
|
Yeah, it's OK with me. We can tackle that stuff later. |
I don't want to anachronistically update the v2.x upgrade guide to reference libraries that didn't exist at the time, but it's worth noting that the API to scroll-behavior has in fact changed.