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.

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

Add version support to published docs #358

Open
Vye opened this issue Mar 28, 2024 · 3 comments
Open

Add version support to published docs #358

Vye opened this issue Mar 28, 2024 · 3 comments

Comments

@Vye
Copy link

Vye commented Mar 28, 2024

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: #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
Copy link
Collaborator

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
Copy link
Owner

dbrgn commented Apr 9, 2024

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

@dbrgn
Copy link
Owner

dbrgn commented Apr 9, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants