Skip to content

[Feature Request]: Client-side filter of content based on version handlers #1647

@theletterf

Description

@theletterf

Prerequisites

  • I have searched existing issues to ensure this feature hasn't already been requested
  • I have tested using the latest version of docs-builder

What problem are you trying to solve?

Currently, we publish docs from a branch. To visualize the docs, we select a major version from the version selector, which loads content built from a branch.

What if instead of branches we had a version view/filter that showed the cumulative docs with only the content that applies up to the selected version?

This would allow us to avoid branches entirely and show to users exactly what applies to them, if content is properly tagged.

Proposed Solution

It could work like this:

  • The build process would add some tags / ids to relevant context.
  • You would select an exact X.Y.Z version from a dropdown / slider / other widget.
  • Client-side JS would hide / show applicable content depending on the version

Examples and Research

The only system I know that does this is https://asciidocsy.netlify.app/docs/theme/config/versioning

Alternative Solutions

No response

Additional Context

No response

How important is this feature to you?

Important

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions