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

Release Notes should distinguish end-user features from back-end stuff #4637

Open
vassudanagunta opened this issue Jul 14, 2023 · 0 comments
Labels
Area: Documentation Status: Triage Needs to be verified, categorized, etc

Comments

@vassudanagunta
Copy link

Description

When an end user is looking at installing a new version, they just want to see what new thing they get to do. If that's buried amongst items like "Add Plausible analytics to mermaid.js.org" and "Support for development in Docker", it can be hard to tell which things affect them, and whether it's worth updating.

In fact, for the 10.2.4 release notes, I count one minor change (switching to Unicode «/» from ASCII <</>> to), one bug fix, one genuine new feature along with seven back-end items listed under Features.

Steps to reproduce

Look at the 10.2.4 release notes from the perspective of an end-user.

Screenshots

No response

Code Sample

No response

Setup

  • Mermaid version:
  • Browser and Version: [Chrome, Edge, Firefox]

Suggested Solutions

No response

Additional Context

No response

@vassudanagunta vassudanagunta added Status: Triage Needs to be verified, categorized, etc Type: Bug / Error Something isn't working or is incorrect labels Jul 14, 2023
@jgreywolf jgreywolf added Area: Documentation and removed Type: Bug / Error Something isn't working or is incorrect labels Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Status: Triage Needs to be verified, categorized, etc
Projects
None yet
Development

No branches or pull requests

2 participants