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 Docs - limiting search context #857

Closed
MartinMuzatko opened this issue Sep 21, 2018 · 4 comments
Closed

Version Docs - limiting search context #857

MartinMuzatko opened this issue Sep 21, 2018 · 4 comments
Labels
type: feature request Request to add a new feature

Comments

@MartinMuzatko
Copy link
Contributor

MartinMuzatko commented Sep 21, 2018

Feature request

Some projects offer documentation for different versions of their software.
In order to meaningfully navigate these, it would be nice to have something like a version context.

Versions are commonly organized as folders like so:
docs/1.2, docs/2.0

What problem does this feature solve?

Cover documentation for multiple versions without having multiple Vuepress installations.

What does the proposed API look like?

This feature involves a few smaller features:

  • Limit search to a certain parent folder (only search in docs/2.0)
  • Add a version picker based on folders to switch contexts
  • Redirect to most recent version on index

How should this be implemented in your opinion?

It could work similar to the sidebar. Limiting the search could make use of the site metadata api so we can see how based on the folders, to only include relevant items.

versions could work as dropdown. Similar to how this software company does documentation: https://help.k15t.com/scroll-versions/latest/scroll-versions-documentation-110528202.html (right upper corner)

Are you willing to work on this yourself?

I'm extending my own theme and will see how I can go from there. It is not that easy maybe, because I have to see how flexible the settings have to be. Is it ok to assume versions are only located in the topmost parent folder?

@MartinMuzatko MartinMuzatko changed the title Version context Version context - limiting search context Sep 21, 2018
@MartinMuzatko MartinMuzatko changed the title Version context - limiting search context Version Docs - limiting search context Sep 21, 2018
@ulivz ulivz added the type: feature request Request to add a new feature label Sep 21, 2018
@ulivz
Copy link
Member

ulivz commented Sep 21, 2018

Good feature request 👍

@robsontenorio
Copy link
Contributor

@MartinMuzatko What mechanism do you use to versioning docs automatically?

@robsontenorio
Copy link
Contributor

See #1032

@ulivz
Copy link
Member

ulivz commented Mar 12, 2019

For docs please see here.

@ulivz ulivz closed this as completed Mar 12, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: feature request Request to add a new feature
Projects
None yet
Development

No branches or pull requests

3 participants