Skip to content

Commit ca5af9b

Browse files
committed
docs(releases): separate Releases section, promote upgrade guide
- Create dedicated "Releases" toctree section in main index - Move upgrade_2x_to_3 from releases/index to main Releases section - Add seealso link to upgrade guide at top of 3.0.0 release notes
1 parent 45e202e commit ca5af9b

3 files changed

Lines changed: 13 additions & 2 deletions

File tree

docs/index.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,18 @@ weighted_transitions
5151
:caption: Reference
5252
:maxdepth: 2
5353
54-
releases/3.0.0
5554
api
5655
auto_examples/index
5756
contributing
5857
authors
58+
```
59+
60+
```{toctree}
61+
:caption: Releases
62+
:maxdepth: 2
63+
64+
releases/3.0.0
65+
releases/upgrade_2x_to_3
5966
releases/index
6067
```
6168

docs/releases/3.0.0.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
*Not released yet*
44

5+
```{seealso}
6+
Upgrading from 2.x? See [](upgrade_2x_to_3.md) for a step-by-step
7+
migration guide.
8+
```
9+
510
## What's new in 3.0.0
611

712
Statecharts are there! 🎉

docs/releases/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ Below are release notes through StateMachine and its patch releases.
1616
:maxdepth: 2
1717
1818
3.0.0
19-
upgrade_2x_to_3
2019
2120
```
2221

0 commit comments

Comments
 (0)