jozu-ai / kitops

Tools for easing the handoff between AI/ML and App/SRE teams.
https://KitOps.ml
Apache License 2.0
206 stars 20 forks source link

Include current CLI version in generated docs page #279

Closed amisevsk closed 2 weeks ago

amisevsk commented 1 month ago

Description

Add version to CLI reference page, now (slightly) less ugly:

Screenshot 2024-05-15 at 5 53 07 PM

Linked issues

Closes #146

amisevsk commented 1 month ago

Just realized that this will look strange with our current version format 0.2.0-93739be

javisperez commented 1 month ago

Just realized that this will look strange with our current version format 0.2.0-93739be

As it lives in the package.json maybe we can just show it in the sidebar, in a smaller, less "eye catching" way? just throwing ideas...

gorkem commented 1 month ago

I agree, I was not expecting it on the header. Somewhere on the sidebar makes sense.

amisevsk commented 1 month ago

We can put it wherever we like, I just don't see a good spot in the sidebar (unless we want to do a dropdown + previous versions, but that seems like a v1.0 problem).

bmicklea commented 1 month ago

We're doing this so we can check for consistency, not because we're doing a fancy drop-dow-to-view-old-versions thing. So my vote would be: