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

Versioning Menu #224

Open
Lachlan-White opened this issue Dec 7, 2023 · 4 comments
Open

Versioning Menu #224

Lachlan-White opened this issue Dec 7, 2023 · 4 comments
Labels
enhancement New feature or request

Comments

@Lachlan-White
Copy link

Feature Description

When it comes to documentation a feature such as versioning of the content, based on the released version of the product is a core feature menu would like. Whilst this can be done by manually creating folders and copying and altering documentation, the management would become burdensome.

Problem/Solution

New Capability - Managed content based on user-selected version.

Alternatives Considered

Mentioned in description

Additional Context

Existing Themes such as Docsy do this:
https://www.docsy.dev/docs/adding-content/versioning/#displaying-a-banner-on-archived-doc-sites

@Lachlan-White
Copy link
Author

@imfing any thoughts on how this could be achieved?

@imfing
Copy link
Owner

imfing commented Dec 20, 2023

Whilst this can be done by manually creating folders and copying and altering documentation, the management would become burdensome.

what's the reason behind copying and altering?

I think a practical approach would be:

  1. similar to github releases, publish the previous versions from Git tags or branches to different sites. For example, v1.docs.your-company.com, v2.docs.your-company.com etc.
  2. within the theme, point to those previous versions either in the navigation bar or in the sidebar.

just like what docsy does: https://www.docsy.dev/docs/adding-content/versioning/#adding-a-version-drop-down-menu

Let me know what your thoughts are

@Lachlan-White
Copy link
Author

Agree that could be a good approach, would be nice to have a similar way to navigate between versions of the released documentation site like docsy with a banner on version

@imfing imfing added the enhancement New feature or request label Dec 21, 2023
@imfing
Copy link
Owner

imfing commented Dec 21, 2023

@Lachlan-White thanks. I also agree that it's something good to have, especially for software documentation site.

We do have an open incomplete PR #221 that implements the sub-menu support in the navigation bar. It can also be used to include multiple versions of the previous sites.

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