From 50657cb5c4421cb25c03bafd9a057f20d8097490 Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Tue, 17 Dec 2024 15:17:32 -0600 Subject: [PATCH 1/2] docs: migration guide tweaks (#1123) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## 🧰 Changes fixing up a few oversights that fell through the cracks! will backport these changes to v9 once this is merged. --- documentation/migration-guide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/migration-guide.md b/documentation/migration-guide.md index 464fbeec..647373f9 100644 --- a/documentation/migration-guide.md +++ b/documentation/migration-guide.md @@ -173,7 +173,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` @@ -192,14 +191,16 @@ Please see [the `rdme@8.0.0` 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... From 3588c5adbdc31d541bc03b29bfd14014247c97e7 Mon Sep 17 00:00:00 2001 From: Kanad Gupta Date: Tue, 17 Dec 2024 15:17:32 -0600 Subject: [PATCH 2/2] docs: migration guide tweaks (#1123) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ## 🧰 Changes fixing up a few oversights that fell through the cracks! will backport these changes to v9 once this is merged. --- documentation/migration-guide.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/migration-guide.md b/documentation/migration-guide.md index bc42f499..c289c4cd 100644 --- a/documentation/migration-guide.md +++ b/documentation/migration-guide.md @@ -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 `rdme@8.0.0` 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...