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

[Feature]: Allow Users to Access Human-Readable Changelogs #616

Closed
garrettmflynn opened this issue Feb 15, 2024 · 3 comments
Closed

[Feature]: Allow Users to Access Human-Readable Changelogs #616

garrettmflynn opened this issue Feb 15, 2024 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@garrettmflynn
Copy link
Member

@CodyCBakerPhD and I had an interesting discussion about human-readable changelogs during our last meeting, which prompted some ideas about how to handle change updates for users.

If we enable auto-update, it would be ideal for users to have a narrative description of the latest changes rather than simply encouraged to review the CHANGELOG.md file. This could be achieved by a blog on the NWB GUIDE documentation.

We also discussed a possible need for persistent versioning, though this seems more like an alternative approach to the blog.

@garrettmflynn garrettmflynn self-assigned this Feb 15, 2024
@CodyCBakerPhD
Copy link
Collaborator

@rly Persistent versioning of docs came up in last meeting, were you going to try to implement that?

@CodyCBakerPhD
Copy link
Collaborator

I've also noticed in a lot of other desktop applications, one of the fields in the top selector (place where we usually find the dev console and such) says something about 'view changelog' and they are usually very human readable

@garrettmflynn garrettmflynn changed the title Narrative Change Descriptions via Short Blogs [Feature]: Allow Users to Access Human-Readable Changelogs Apr 19, 2024
@garrettmflynn garrettmflynn added the enhancement New feature or request label Apr 19, 2024
@CodyCBakerPhD
Copy link
Collaborator

This was added as apart of #760

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants