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

Version individual sections for clients #3135

Open
Paultagoras opened this issue Jan 23, 2025 · 4 comments
Open

Version individual sections for clients #3135

Paultagoras opened this issue Jan 23, 2025 · 4 comments
Assignees
Labels

Comments

@Paultagoras
Copy link
Contributor

As discussed #3071 it would be nice if we could have a single page with multiple versions, so that docs could be collapsed - it would help customers find the current version, while still allowing older access.

@Paultagoras
Copy link
Contributor Author

@gingerwizard Is this something you're aware of how to do?

@gingerwizard
Copy link
Contributor

yes we'll handle @Paultagoras

@gingerwizard gingerwizard self-assigned this Jan 29, 2025
@gingerwizard gingerwizard added this to the Feb 2025 milestone Jan 29, 2025
@gingerwizard
Copy link
Contributor

facebook/docusaurus#2528 ideal i think

@gingerwizard gingerwizard changed the title Version individual sections Version individual sections for clients Jan 29, 2025
@Blargian Blargian assigned Blargian and unassigned Blargian Feb 17, 2025
@Blargian Blargian removed this from the Feb 2025 milestone Feb 17, 2025
@Blargian
Copy link
Member

Blargian commented Feb 27, 2025

Adopting the Docusaurus approach to versioning on this isn't going to work without substantial changes to the structure of the docs I don't think - it's designed more for the use case where your entire project has a single version, rather than having different pages versioned.

@Paultagoras what if we have a React component which is a dropdown menu item on the page itself somewhere near the top of the page that can be used to select the version? When the user selects the version it will just do a page change. We use this trick here https://clickhouse.com/docs/knowledgebase for the component that lets you switch between "Recent" and "Grouped by tags". It's actually two separate pages but it gives the illusion that it's a single page application.

Image

Like this but on the page itself rather than in a menu:

Image

Only downside I can really think of is that we'll need to import this component on every version markdown page and have to manually update it on each page every time a new version is added. If new versions are infrequent then this shouldn't be too much of a problem either.

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

No branches or pull requests

3 participants