prototype inclusion of release notes in docs

[cburroughs]

• Treat them as a top level "type" of doc
• Sidebar sorting is finicky :-/
• Some friction around when we write the notes versus switch the
  'current' doc version

ref #89

[cburroughs]

cc @thejcannon @huonw

Have not used docusaurus before, not sure if this is on the right track.

[huonw]

The idea sounds good! Just brainstorming:

• It'd be good to include this as part of the syncing process (I'm guessing you're not dotting Is/crossing Ts like this until you've got agreement on the direction, which is fine and sensible)
• It seems like this is going in a direction where every version repeats all of the release notes from all prior versions, which doesn't seem "perfect". I wonder if these could either be:
  • "evergreen", i.e. placed within src/pages and accessible from all versions (but still updated as part of the sync process)
  • "properly" versioned, i.e. each version just has one release notes page, which is the notes for the current series, and the 'normal' version switcher can be used to see the notes for different series (because they're all at the same 2.x/... url, other than the x)
• Also, did you have any specific questions re docusaurus? (not that I can necessarily help, I'm still learning too 😅 )

[cburroughs]

seems like this is going in a direction where every version repeats all of the release notes from all prior versions, which doesn't seem "perfect".

It seems to be good enough for various prominent Python projects so I decided I was okay with it:
https://click.palletsprojects.com/en/6.x/changelog/

But yeah it does feel slightly wonky.

I think evergreen is reasonable, but that makes the syncing inconsistent which might be it's own form of wonkyness?

"properly" versioned, i.e. each version just has one release notes page, which is the notes for the current series, and the 'normal' version switcher can be used to see the notes for different series

I think that's reasonable from an avoiding syncing wonkyness perspective but I'm struggling to visualize a project website that does it that way. It's usually a list.

[thejcannon]

I think it just being an evergreen page (akin to, and maybe linked from) the versions page is fine.

We can either special case the syncing, or just keep them in this repo and update them here if that's too weird