Skip to content

Commit 133855d

Browse files
doc: Add changelog to users guide. (#708)
Co-authored-by: David Thrane Christiansen <[email protected]>
1 parent f1fc1ec commit 133855d

File tree

3 files changed

+52
-0
lines changed

3 files changed

+52
-0
lines changed

doc/UsersGuide/Basic.lean

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import UsersGuide.Manuals
1010
import UsersGuide.Elab
1111
import UsersGuide.Extensions
1212
import UsersGuide.Output
13+
import UsersGuide.Releases
1314

1415
open Verso.Genre Manual
1516

@@ -117,6 +118,7 @@ number := false
117118

118119
{theIndex}
119120

121+
{include 0 UsersGuide.Releases}
120122

121123
# Dependencies
122124
%%%

doc/UsersGuide/Releases.lean

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
/-
2+
Copyright (c) 2026 Lean FRO LLC. All rights reserved.
3+
Released under Apache 2.0 license as described in the file LICENSE.
4+
Author: Emilio J. Gallego Arias
5+
-/
6+
7+
import VersoManual
8+
9+
import UsersGuide.Releases.«v4_28_0»
10+
11+
open Verso Genre Manual
12+
13+
#doc (Manual) "Release Notes" =>
14+
%%%
15+
tag := "release-notes"
16+
file := "releases"
17+
number := false
18+
htmlSplit := .never
19+
%%%
20+
21+
This section provides release notes about recent versions of Verso. When updating to a new version, please
22+
read the corresponding release notes. They may contain advice that will help you understand
23+
the differences with the previous version and upgrade your projects.
24+
25+
Verso versioning follows Lean's.
26+
This means that we release a new version for each Lean release, usually once per month.
27+
In particular, note that Verso doesn't follow the [semantic versioning model](https://semver.org/).
28+
29+
{include 0 UsersGuide.Releases.«v4_28_0»}
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/-
2+
Copyright (c) 2026 Lean FRO LLC. All rights reserved.
3+
Released under Apache 2.0 license as described in the file LICENSE.
4+
Author: Emilio J. Gallego Arias
5+
-/
6+
7+
import VersoManual
8+
9+
open Verso.Genre
10+
11+
-- To allow ```` below
12+
set_option linter.verso.markup.codeBlock false
13+
14+
#doc (Manual) "Verso 4.28.0 (unreleased)" =>
15+
%%%
16+
tag := "release-v4.28.0"
17+
file := "v4.28.0"
18+
%%%
19+
20+
* Add Release Notes / Changelog to Verso Users guide (@ejgallego, #708)
21+

0 commit comments

Comments
 (0)