docs: remove redundant docs versioning #4066
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
## Summary This PR fixes links to React Native Gesture Handler documentation on `useAnimatedGestureHandler` hook
tomekzaw
added a commit
that referenced
this pull request
Feb 23, 2023
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect. --> ## Summary This PR fixes a broken link in the error message in `reanimated_utils.rb` which no longer works because `next` version was removed by @kacperkapusciak in #4066. ## Test plan Check if the URL is valid.
fluiddot
pushed a commit
to wordpress-mobile/react-native-reanimated
that referenced
this pull request
Jun 5, 2023
## Summary
This PR contracts all "v2" docs versions (i.e. `2.0.x`, `2.1.x`, `2.2x`,
`2.3.x-2.4.x`, `2.5.x-2.10.x`) into one `2.x` version, renames `1.x.x`
to `1.x` and adds `3.x` which is now marked as the current version.
In order to keep old-links working (stack overflow responses, discord
comments, slack threads) all legacy versions are redirected to their
appropriate slots.
For example:
- `/docs/2.1.x/api/cancelAnimation` is going to be redirected to
`/docs/2.x/api/animations/cancelAnimation`,
- `/docs/2.0.x/events` to `/docs/2.x/fundamentals/events` and,
- `/docs/1.x.x/nodes/startClock` to `/docs/1.x/nodes/startClock`.
### Actions taken
- Removed all legacy versions besides `1.x.x` and renamed it to `1.x`
- Regenerated `2.x` version by running `yarn docusaurus docs:version
2.x`. This created a copy of the most recent docs and sidebar config
into `versions-2.x` folder (and `version-2.x-sidebars.json`)
- Labeled `next` version as `3.x` and marked it as the current default
docs.
- Added redirects for all appropriate legacy versions to 2.x and 1.x
versions
- Added `XYZ is available since vx.x.x` labels to features which weren't
added in 2.x version of Reanimated. These features were:
- `useScrollViewOffset` (added in v2.11)
- `useAnimatedKeyboard` (added in v2.10)
- `useFrameCallback` (added in v2.10)
- `useAnimatedSensor` (added in v2.5)
- `LayoutAnimations` (added in v2.3)
- Upgraded Docusaurus to the newest (2.3.1) version
## Screenshots
### Before
<img width="221" alt="image"
src="https://user-images.githubusercontent.com/39658211/219692026-35eacf34-e0c1-4955-b47a-c20a4e6c7e11.png">
### After
<img width="237" alt="image"
src="https://user-images.githubusercontent.com/39658211/220660846-61c433e6-cc56-4fc6-bd39-886b01001299.png">
An example `XYZ is available since vx.x.x` label:
<img width="725" alt="image"
src="https://user-images.githubusercontent.com/39658211/220083875-98fe01a7-b63d-4157-9709-74fe517e60cf.png">
fluiddot
pushed a commit
to wordpress-mobile/react-native-reanimated
that referenced
this pull request
Jun 5, 2023
<!-- Thanks for submitting a pull request! We appreciate you spending the time to work on these changes. Please follow the template so that the reviewers can easily understand what the code changes affect. --> ## Summary This PR fixes a broken link in the error message in `reanimated_utils.rb` which no longer works because `next` version was removed by @kacperkapusciak in software-mansion#4066. ## Test plan Check if the URL is valid.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR contracts all "v2" docs versions (i.e.
2.0.x,2.1.x,2.2x,2.3.x-2.4.x,2.5.x-2.10.x) into one2.xversion, renames1.x.xto1.xand adds3.xwhich is now marked as the current version.In order to keep old-links working (stack overflow responses, discord comments, slack threads) all legacy versions are redirected to their appropriate slots.
For example:
/docs/2.1.x/api/cancelAnimationis going to be redirected to/docs/2.x/api/animations/cancelAnimation,/docs/2.0.x/eventsto/docs/2.x/fundamentals/eventsand,/docs/1.x.x/nodes/startClockto/docs/1.x/nodes/startClock.Actions taken
1.x.xand renamed it to1.x2.xversion by runningyarn docusaurus docs:version 2.x. This created a copy of the most recent docs and sidebar config intoversions-2.xfolder (andversion-2.x-sidebars.json)nextversion as3.xand marked it as the current default docs.XYZ is available since vx.x.xlabels to features which weren't added in 2.x version of Reanimated. These features were:useScrollViewOffset(added in v2.11)useAnimatedKeyboard(added in v2.10)useFrameCallback(added in v2.10)useAnimatedSensor(added in v2.5)LayoutAnimations(added in v2.3)Screenshots
Before
After
An example
XYZ is available since vx.x.xlabel: