Skip to content

Commit 1b16b7c

Browse files
committed
doc: Added changelog to users guide.
1 parent dbe83a1 commit 1b16b7c

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: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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_27_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+
{include 0 UsersGuide.Releases.«v4_27_0»}
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
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+
-- EJGA: Should we use the markdown code block from ref-manual?
10+
-- import Manual.Meta.Markdown
11+
12+
open Verso.Genre
13+
14+
-- To allow ```` below
15+
set_option linter.verso.markup.codeBlock false
16+
17+
#doc (Manual) "Verso 4.27.0 (unreleased)" =>
18+
%%%
19+
tag := "release-v4.27.0"
20+
file := "v4.27.0"
21+
%%%
22+
23+
````
24+
* Added Release Notes / Changelog to Verso Users guide
25+
````

0 commit comments

Comments
 (0)