Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: migration guide tweaks #1123

Merged
merged 5 commits into from
Dec 17, 2024
Merged

docs: migration guide tweaks #1123

Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3acc542
chore: tsconfig cleanup
kanadgupta Dec 17, 2024
72d97eb
docs: fix list
kanadgupta Dec 17, 2024
9f21862
docs: update table with smol callout
kanadgupta Dec 17, 2024
fbece6d
Revert "chore: tsconfig cleanup"
kanadgupta Dec 17, 2024
683ef66
docs: feedback
kanadgupta Dec 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions documentation/migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand All @@ -192,14 +191,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, we've added a backwards compatibility layer so existing integrations using older `rdme` versions (e.g., `v8`, `v9`, etc.) should continue to work. **For best results, we recommend that all projects on ReadMe Refactored upgrade 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...
Expand Down
Loading