HiDeoo / starlight-versions

Starlight plugin to version documentation pages
https://starlight-versions.vercel.app
MIT License
16 stars 1 forks source link

demo of branching style versioning #3

Closed DefinitelyMaybe closed 2 months ago

DefinitelyMaybe commented 2 months ago

Is your feature request related to a problem?

Hi there! coming from threlte docs here. Thank you for your work on this starlight plugin as well as the others you've made, great stuff 👍

I'm wanting to make a starlight version of our docs using this plugin. For right now, we can make do with folder based versioning but would love to see a branch based demo sometime in the future

Describe the solution you'd like

a branch based versioning demo 🎉

Describe alternatives you've considered

Will do a folder based versioning for the moment

Additional Context

No response

HiDeoo commented 2 months ago

Thanks for the interest and kind words :raised_hands:

As mentioned in the documentation, this plugin was designed to be opionated towards a folder-based versioning strategy and I don't think I have any plans to support other strategies in this plugin.

My more long term idea was:

Considering how different a folder-based strategy is from a branch (or tag) based one and how early this plugin is in its development, so far I don't think having a plugin supporting multiple strategies would be a good idea even maintenance-wise. Maybe work on this plugin will change my mind though.

DefinitelyMaybe commented 2 months ago

Ah, sorry I miss read the docs 😅

Haha opinions can change but happy to cross that bridge when we get there 👍