adding release notes for v1.0.0 #333
Conversation
|
@pkienzle are we good to merge this in? i see it was approved about a month ago but we've since released 1.0.0 so i wasn't sure if this is outdated |
|
These notes were used in the github release - I don't know if we want to keep them in the git tree as well. As-is, this is just another markdown file in the repo, but if we keep it then we might want to include it in the sphinx docs. |
|
ahhh I see. in that case I'm inclined to just close, and can the GitHub release notes good enough, if that works for you |
|
It seems useful to have the release notes for the entire history in the repo rather than in github metadata. Not sure how to organize it though. Historically I've just prepended them to the human generated changelog summary file. |
|
@pkienzle that seems reasonable - but only if we can use markdown for the changelog, so we can cut and paste back and forth between release notes on github and the changelog. Does that sound ok? |
|
Markdown is okay. We don't need to suck it into the sphinx docs. |
No description provided.