-
Notifications
You must be signed in to change notification settings - Fork 43
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: migration guide tweaks (#1123)
## 🧰 Changes fixing up a few oversights that fell through the cracks! will backport these changes to v9 once this is merged.
- Loading branch information
1 parent
bd55e70
commit 3588c5a
Showing
1 changed file
with
4 additions
and
3 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -117,7 +117,6 @@ If you're using the `rdme` GitHub Action, update your GitHub Actions workflow fi | |
The following commands (and their subcommands) will be removed in `rdme@10`: | ||
|
||
- `categories` | ||
- `changelogs` | ||
- `custompages` | ||
- `docs` (and its `guides` alias) | ||
- `versions` | ||
|
@@ -136,14 +135,16 @@ Please see [the `[email protected]` release notes](https://github.com/readmeio/rdme/rel | |
|
||
## Version Compatibility Matrix | ||
|
||
| Feature | v8 | v9 | v10 | | ||
| Feature | `v8` | `v9` | `v10` | | ||
| ------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ----------- | ----------- | | ||
| Actively Maintained? | ❌ | ✅ | ✅ | | ||
| Support for [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored) | ❌ | ❌ | ✅ | | ||
| Support for [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored)\* | ❌ | ❌ | ✅ | | ||
| Supports Bi-Directional Sync | ❌ | ❌ | ✅ | | ||
| Support for Legacy Projects (i.e., not yet migrated to [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored)) | ✅ | ✅ | ❌ | | ||
| Node.js Requirements | `>=14` | `>=20.10.0` | `>=20.10.0` | | ||
|
||
\*If you uploaded an API definition prior to migrating your project to ReadMe Refactored, any existing workflows for syncing these files that use a legacy `rdme` version (i.e., `v9` or earlier) should continue to work, even after migrating. **For new workflows, we recommend following this migration guide and upgrading to the latest version.** | ||
|
||
## Need Help? | ||
|
||
If you notice any issues or disruptions to your workflow during migration, we're here to help! Feel free to... | ||
|