hashgraph / hedera-docs

Welcome to the official Hedera documentation repository.
https://docs.hedera.com
60 stars 110 forks source link

Rethink the release notes section in docs #387

Open SimiHunjan opened 1 year ago

SimiHunjan commented 1 year ago

Problem

The release notes section in docs covers the release notes for mirror node services releases. The section contains the history of releases for the last few years. It is unlikely we want to keep the entire history of releases on docs as the release history is kept in the individual GitHub repos for each project.

Solution

Come up with a solution on how we should maintain the release notes section. For example, we keep the last 12 months of releases and discard the rest. Provide the link to the release notes for the project if devs need to go back further than the time we support on docs.

Alternatives

No response

### Tasks
- [ ] https://github.com/hashgraph/hedera-docs/issues/201
a-ridley commented 8 months ago

Below are a couple of different ways changelogs/release notes are presented:

Twilio Changelog What I think is neat about it:

Slack Release Notes What I think is neat about it:

Slack Changelog What I think is neat about it:

Discord Changelog What I think is neat about it

Solana Release Notes

Reccetech commented 3 months ago

I propose that as an initial step we added a section to the release notes "Release Highlights" where we list the major updates, their functionality, and benefits.

For example:

Release Highlights

HIP 206 Functionality:

Benefits: