search

dbrgn / tealdeer

A very fast implementation of tldr in Rust.
https://dbrgn.github.io/tealdeer/
Apache License 2.0
4.06k stars 123 forks source link

Add version support to published docs #358

Open Vye opened 4 months ago

Vye commented 4 months ago

Hi,

Can versioning be added to the docs? I'm a new user and went through a fair amount of unnecessary steps to figure out custom page extension listed in docs is for an unreleased commit in main. :(

Extension changed: https://github.com/dbrgn/tealdeer/issues/320

No .md extension docs for 1.6.1 tag: https://github.com/dbrgn/tealdeer/blob/v1.6.1/docs/src/usage_custom_pages.md

With .md extension live docs with new extension: https://dbrgn.github.io/tealdeer/usage_custom_pages.html

Thanks for the client!

niklasmohrin commented 4 months ago

That sounds like a good idea. If someone can come up with a not too complicated setup for this, it would be greatly appreciated :)

In the mean time, maybe we should only update github pages when we push a new release, not for every commit on main @dbrgn ?

dbrgn commented 4 months ago

Yeah, it would probably make sense to have versioned docs. I don't know what would be required for that though.

dbrgn commented 4 months ago

In the mean time, maybe we should only update github pages when we push a new release, not for every commit on main @dbrgn ?

That might be a good stop-gap solution until then.