javadoc: Deprecate legacy classes and add migration guidance to FesodSheet by GOODBOY008 · Pull Request #699 · apache/fesod
I suggest adding a separate documentation directory.
I agree to add it as a separate page, but I recommend a subpage under
Quick Start, such as theVersion Upgrade Guide.
@delei Thanks for the suggestion!
Quick Start is for new users, while a Migration Guide targets existing users upgrading from an older version. These are different audiences, so nesting migration content inside Quick Start could confuse readers.
For example:
• Vue Migration Guide (top-level): https://v2.vuejs.org/v2/guide/migration
• JUnit 4 → 5 Migration (top-level): https://docs.junit.org/current/user-guide/#migrating-from-junit4
Keeping Migration Guide as a sibling of Quick Start ensures:
1. Clear separation between onboarding and upgrade content
2. Easier discoverability for migrating users
3. Cleaner, more focused Quick Start section
I recommend placing Migration Guide at the top level rather than inside Quick Start.
@psxjoy Would you like to join this discussion and share your thoughts on this subject?