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.

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

Documentation multi-version management feature #3914

Open
BaiJiangJie opened this issue Jan 10, 2025 · 1 comment
Open

Documentation multi-version management feature #3914

BaiJiangJie opened this issue Jan 10, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@BaiJiangJie
Copy link

BaiJiangJie commented Jan 10, 2025

Dear R&D Team,

I’m currently writing documentation for a product, but the product iterates quite quickly, with a major release almost every month. If we use Nextra, how can we manage multiple versions of the documentation and enable users to select different versions on the page?

A version-switching feature similar to Django’s documentation.

image

Thanks Everyone!

@BaiJiangJie BaiJiangJie added the enhancement New feature or request label Jan 10, 2025
@oobg
Copy link

oobg commented Jan 13, 2025

Let me share an idea I’ve been considering, and I’d like to hear your thoughts on whether it’s a good approach.
However, this assumes that the feature is implemented without using i18n on the page.

Refer to the official Nextra documentation.
https://nextra.site/docs/docs-theme/page-configuration#menus

Add a menu item to the navbar to navigate between versioned pages, similar to how it’s done in the Nextra documentation.

image

Also, take a look at the i18n functionality.
https://nextra.site/docs/guide/i18n#add-i18n-config

What do you think about using the i18n multilingual feature for version management routing?

In other words, use i18n routing for version control and add menu items to the Nextra navbar so users can switch between versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants