Skip to content

doc: Added 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.

Sign up for GitHub

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

Open
ejgallego wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: Added changelog to users guide. #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/UsersGuide/Basic.lean
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import UsersGuide.Manuals
import UsersGuide.Elab
import UsersGuide.Extensions
import UsersGuide.Output
import UsersGuide.Releases

open Verso.Genre Manual

Expand Down Expand Up @@ -117,6 +118,7 @@ number := false

{theIndex}

{include 0 UsersGuide.Releases}

# Dependencies
%%%
Expand Down
25 changes: 25 additions & 0 deletions doc/UsersGuide/Releases.lean
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/-
Copyright (c) 2026 Lean FRO LLC. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.
Author: Emilio J. Gallego Arias
-/

import VersoManual

import UsersGuide.Releases.«v4_27_0»

open Verso Genre Manual

#doc (Manual) "Release Notes" =>
%%%
tag := "release-notes"
file := "releases"
number := false
htmlSplit := .never
%%%

This section provides release notes about recent versions of Verso. When updating to a new version, please
Copy link
Collaborator

@david-christiansen david-christiansen Jan 23, 2026

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.

read the corresponding release notes. They may contain advice that will help you understand
the differences with the previous version and upgrade your projects.

{include 0 UsersGuide.Releases.«v4_27_0»}
25 changes: 25 additions & 0 deletions doc/UsersGuide/Releases/v4_27_0.lean
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
/-
Copyright (c) 2026 Lean FRO LLC. All rights reserved.
Released under Apache 2.0 license as described in the file LICENSE.
Author: Emilio J. Gallego Arias
-/

import VersoManual

-- EJGA: Should we use the markdown code block from ref-manual?
Copy link
Collaborator

@david-christiansen david-christiansen Jan 23, 2026

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.

-- import Manual.Meta.Markdown

open Verso.Genre

-- To allow ```` below
set_option linter.verso.markup.codeBlock false

#doc (Manual) "Verso 4.27.0 (unreleased)" =>
%%%
tag := "release-v4.27.0"
file := "v4.27.0"
%%%

````
* Added Release Notes / Changelog to Verso Users guide
````
Loading