nwb-guide icon indicating copy to clipboard operation
nwb-guide copied to clipboard

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

Open garrettmflynn opened this issue 1 year ago • 2 comments

@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 avatar Feb 15 '24 22:02 garrettmflynn

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

CodyCBakerPhD avatar Apr 16 '24 15:04 CodyCBakerPhD

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

CodyCBakerPhD avatar Apr 16 '24 15:04 CodyCBakerPhD

This was added as apart of #760

CodyCBakerPhD avatar Jun 10 '24 16:06 CodyCBakerPhD