Kipper icon indicating copy to clipboard operation
Kipper copied to clipboard

[Docs] Update Changelog tab to contain GitHub Release descriptions

Open Luna-Klatzer opened this issue 2 years ago • 0 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues

Current State & Issue

The Changelog tab, which is currently displaying the most recent changes from the main branch on GitHub, is a bit bloated for the users due to the unnecessary technical details that will only be important to API users or internal contributors and due to the fact it does not display the most important changes clearly enough so readers can easily understand them. This is a problem, since the Changelog tab becomes messy and mostly unnecessary since rarely anyone will need to read it.

Expected Changes & Improvements

  • [ ] Related issue: #323
  • [ ] Replace the Changelog Markdown from the Changelog.md file with the release summary from the GitHub Releases page. This would then only include the most important changes and make it more easy to understand what major changes occurred in every release.
  • [ ] Possibly rename the Changelog tab to Releases, so it's more clear to the user what info is displayed there.
  • [ ] Possibly add an optional small button or extra section of the page, where the detailed Changelog would be visible. This should not be enabled per default to avoid bloat of the webpage. This can also be a link to the GitHub file, but preferably it should remain static HTML on the website.

Referenced sites

  • Changelog (https://luna-klatzer.github.io/Kipper/changelog.html)

Luna-Klatzer avatar Oct 02 '22 12:10 Luna-Klatzer