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

[Docs] Update Changelog tab to contain GitHub Release descriptions #324

Open
1 of 5 tasks
Luna-Klatzer opened this issue Oct 2, 2022 · 0 comments
Open
1 of 5 tasks
Assignees
Labels
docs Related to the project docs and info on the repo or website
Milestone

Comments

@Luna-Klatzer
Copy link
Member

Is there an existing issue for this?

  • 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: [Docs] Make the render of the Website Changelog to a static one done before Parcel Deployment #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

@Luna-Klatzer Luna-Klatzer added question Further information is requested docs Related to the project docs and info on the repo or website labels Oct 2, 2022
@Luna-Klatzer Luna-Klatzer self-assigned this Oct 2, 2022
@Luna-Klatzer Luna-Klatzer added hacktoberfest Hacktoberfest-related issue or pull request and removed question Further information is requested labels Oct 2, 2022
@Luna-Klatzer Luna-Klatzer added this to the Improved Docs milestone Jan 28, 2023
@Luna-Klatzer Luna-Klatzer removed the hacktoberfest Hacktoberfest-related issue or pull request label Jul 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Related to the project docs and info on the repo or website
Projects
Status: Under Consideration
Development

No branches or pull requests

1 participant