-
Notifications
You must be signed in to change notification settings - Fork 100
doc: Add changelog to users guide. #708
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
Conversation
doc/UsersGuide/Releases/v4_27_0.lean
Outdated
|
|
||
| import VersoManual | ||
|
|
||
| -- EJGA: Should we use the markdown code block from ref-manual? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think not. That exists as an artifact of the "export from GitHub" feature. We can just write them in Verso.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! Updated to:
* Add Release Notes / Changelog to Verso Users guide (@ejgallego, #708)
Would that work OK? I'd be happy to implement a PR role, so we could instead do {pr 708}.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think {pr}[708] would be nice, but we don't need it. If you feel like it, go for it, but better to get the rest of your dependent PRs merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Makes sense, thanks. I'll do the {pr ...} role in a separate, low-prio PR.
| htmlSplit := .never | ||
| %%% | ||
|
|
||
| This section provides release notes about recent versions of Verso. When updating to a new version, please |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should have a little note here that our version numbers are synced with the Lean version, so there's one Verso release per Lean release with no expectation of cross-Lean-version compatibility. In other words, our version number in this manual is not a semantic version.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the comments. Should be addressed.
Co-authored-by: David Thrane Christiansen <[email protected]>
No description provided.