GOODBOY008 commented on PR #699:
URL: https://github.com/apache/fesod/pull/699#issuecomment-3557547149

   > > 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 the `Version 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?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to