Skip to content

[ISSUE]: Documentation "5.12.0"/"latest" link is confusing #4537

Open
@snctfd

Description

@snctfd

Prerequisites

  • I have written a descriptive issue title
  • I have searched issues to ensure it has not already been reported

GitVersion package

N/A

GitVersion version

N/A

Operating system

N/A

What are you seeing?

The documentation page has a header with a link between "latest" and "5.12.0" docs, introduced in PR 4188. This is certainly nice to have, but as a new user, the fact that the "latest" documentation shows "5.12.0" in the header was initially quite confusing. This would probably have been fine if there were several different versions to choose from in the header, but with only one link displayed in the header, the obvious interpretation is that the header shows "this is the version you're on", not "click here to go to this version".

An additional contributing factor in my case is that my browser (Arc) by default only shows the domain name. Looking at the full URL makes it quite clear which version you're looking at, but this should not be necessary.

What is expected?

Some possible ways to improve the UI here:

  • Add some phrasing to the link between versions (e.g. "Go to [version]"). Clunky solution that doesn't scale if we want to add more links.
  • Add more version links, and optionally turn the version selection into a dropdown. This would more clearly communicate that you're making a selection that takes you elsewhere.
  • Show which version of the docs you're looking at somewhere, e.g. in the footer.

Steps to Reproduce

N/A

RepositoryFixture Test

No response

Output log or link to your CI build (if appropriate).

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions