feat: added versioning for docs

[addegbenga]

What type of PR is this? (check all applicable)

• 🍕 Feature
• 🐛 Bug Fix
• 📝 Documentation Update
• 🎨 Style
• 💻 Code Refactor
• 🔥 Performance Improvements
• ✅ Test
• 🤖 Build
• 🔁 CI
• 🔌 Chore (Release)
• ⏩ Revert

Description

This pull request introduces versioning to the komiser documentation, ensuring that each major or minor release has its dedicated documentation.

Related Issues

Mobile & Desktop Screenshots/Recordings

Added tests?

• 👍 yes
• 🙅 no, because they aren't needed
• 🙋 no, because I need help

Added to documentation?

• 📜 README.md
• 📓 docs.komiser.io
• 📕 storybook
• 🗒 Code comment intelliSense
• 🙅 no documentation needed

[optional] Are there any post-deployment tasks we need to perform?

None

[optional] What gif best describes this PR or how it makes you feel?

You can use Gif for GitHub extension to generate one

[ShubhamPalriwala]

Hey @addegbenga, absolutely amazing work here 💯 Superglad that you worked on this much needed versioning in the documentation aspect! Having the documentation versioned with the project would be really cool and useful to the end-users!

We plan to release this with the v3.1.0 version of komiser! What we would ideally prefer is, in this existing PR, you could add 2 versions:

• v3.1.0 that includes the changes in this release (you can find here v3.1.0 )
• <v3.1.0 that has all the changes before this release

And an additional CONTRIBUTING.md in this repo that has a step-by-step information on how 1 can update the docs for the next release!

What do you think of the above plan? Would be glad to hear your thoughts on it! I'm personally really excited to see this go live! All credits to you 🚀

[addegbenga]

Hey @addegbenga, absolutely amazing work here 💯 Superglad that you worked on this much needed versioning in the documentation aspect! Having the documentation versioned with the project would be really cool and useful to the end-users!

We plan to release this with the v3.1.0 version of komiser! What we would ideally prefer is, in this existing PR, you could add 2 versions:

* `v3.1.0` that includes the changes in this release (you can find here [v3.1.0](https://github.com/tailwarden/komiser/milestone/27) )

* `<v3.1.0` that has all the changes before this release

And an additional CONTRIBUTING.md in this repo that has a step-by-step information on how 1 can update the docs for the next release!

What do you think of the above plan? Would be glad to hear your thoughts on it! I'm personally really excited to see this go live! All credits to you 🚀

Hello @ShubhamPalriwala above plan sounds good to me, i will revert as soon as possible.

[ShubhamPalriwala]

Hey @addegbenga, any updates on this 🙌🏼 ? We are planning to make a release on Komiser in a while 🤞🏼

[addegbenga]

Hey @addegbenga, any updates on this 🙌🏼 ? We are planning to make a release on Komiser in a while 🤞🏼

Hello @ShubhamPalriwala,
Sorry for the delay I wanted to update you that I've implemented the improvements you suggested in my latest commit. Here's an overview of the changes I made:

Added two versions: v3.0.0 for the previous release and v3.1.0 for the current release. This allows for better version control and easy tracking of changes.

Included a comprehensive contribution guide on how to create a next release and publish it. This will make it easier for other contributors to follow the release process and maintain consistency.

However, I noticed that the docs versions I created are duplicates of one another. how do i make the current release v.3.1.0 docs capture all the changes in this Komiser new release?

[ShubhamPalriwala]

Hey @addegbenga, thanks for the update! All looks perfect to me 🚀 ! We just released a v3.1.0, whenever you are ready with the version, just ping me once and we can merge the updated documentation as well! 🤞🏼