search

WebAudio / web-midi-api

The Web MIDI API, developed by the W3C Audio WG
http://webaudio.github.io/web-midi-api/
Other
321 stars 55 forks source link

Add changelog #259

Closed mjwilson-google closed 7 months ago

mjwilson-google commented 8 months ago

Add a changelog, so we can publish an updated working draft.

Please take a look.

hoch commented 8 months ago

Adding @svgeesus for visibility.

svgeesus commented 8 months ago

What does <rs-changelog from="f7632e65a5708b01fcb78ca04e254e00b5864465"> expand to? A list of commit messages? A diff?

svgeesus commented 8 months ago

Also, once the document is published, will that changelog be static and not include changes after that publication? Because typically you would start a new section Changes since Working Draft xx Nov 2023

hoch commented 8 months ago

@svgeesus rs-changelog is explained here: https://github.com/w3c/respec/wiki/rs-changelog

@mjwilson-google Can you grab a screenshot of the rendered page?

mjwilson-google commented 8 months ago

What does <rs-changelog from="f7632e65a5708b01fcb78ca04e254e00b5864465"> expand to? A list of commit messages? A diff?

It expands to a list of commit messsages which link to diffs. It's not the most user-friendly because some of the commit messsages are not very descriptive, but it's probably the fastest way to get an accurate list of everything that changed. For the from field, I manually searched and verified the first commit that landed after the last Working Draft was published.

Also, once the document is published, will that changelog be static and not include changes after that publication?

I believe so. I've never published a Respec document before, but my understanding is when we run the export step a fully static version of the page is generated and that's what we will upload as the new working draft.

Because typically you would start a new section Changes since Working Draft xx Nov 2023

Yes, although I'm a bit concerned that the changelog section will get very long if we do this. Can we just keep the changes since the previous version in the changelog, and people can go back to previous versions to check those changes?

Here is a screenshot of part of the list; we have eight years of changes so it didn't all fit on one screen: image

svgeesus commented 7 months ago

Yes, although I'm a bit concerned that the changelog section will get very long if we do this. Can we just keep the changes since the previous version in the changelog, and people can go back to previous versions to check those changes?

Sure, that works.