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.

Sign up for GitHub

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

Jump to bottom

Display additional version info the documentation page header #2461

Closed
kaishin opened this issue Jun 22, 2023 · 4 comments · Fixed by #3648
Closed

Display additional version info the documentation page header #2461

kaishin opened this issue Jun 22, 2023 · 4 comments · Fixed by #3648
Assignees
@luis-gustavo
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@kaishin
Copy link

kaishin commented Jun 22, 2023

As discussed with @daveverwer, the documentation page could help visitors quickly identify if they are looking at the latest version. I was made aware of the banner displayed in the older version pages, but the latest version lacks an equivalent affordance.

Potential Solutions

The simplest solution would be to include said info between parentheses in front of the version number in the header (ex. 0.4.3 (latest) or similar.

Something a bit fancier would be a label with a separate visual styling in front of the version handle.

Further Considerations

This same pattern could be used to add information about the latest pre-release version or default branches.
@kaishin kaishin added the bug Something isn't working label Jun 22, 2023
@daveverwer daveverwer added enhancement New feature or request and removed bug Something isn't working labels Jun 22, 2023
@daveverwer
Copy link
Member

Thanks @kaishin! I think this is a good idea. We could consider a very subtle "lozenge" type badge, maybe? I mocked something up:

mockup

Doesn't need to look like that, but it's a possibility.

We should also consider whether we should label it here:

Screenshot 2023-06-22 at 15 24 11@2x

After thinking about it, for now I think just doing the "Latest" (and not the latest prerelease or default branch) is best.

@finestructure
Copy link
Member

After thinking about it, for now I think just doing the "Latest" (and not the latest prerelease or default branch) is best.

I'd agree with that and I think the LATEST lozenge looks nice.

@kaishin
Copy link
Author

kaishin commented Aug 28, 2023

I like the badge mock! The contrast could be improved a bit by making the background darker.
@daveverwer if you can help me with setting things up locally I can open a PR.

@daveverwer
Copy link
Member

@daveverwer if you can help me with setting things up locally I can open a PR.

If you mean local dev setup for the SPI, this guide is up to date as of a couple of weeks ago. Of course, ping me if anything doesn't work!

@finestructure finestructure added the good first issue Good for newcomers label Aug 7, 2024
@luis-gustavo luis-gustavo self-assigned this Jan 29, 2025
@luis-gustavo luis-gustavo mentioned this issue Jan 31, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@luis-gustavo luis-gustavo

Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Added latest badge on latest documentation page SwiftPackageIndex/SwiftPackageIndex-Server
4 participants
@daveverwer @finestructure @kaishin @luis-gustavo