Skip to content

Commit d7671be

Browse files
committed
doc: Restructure release and migration notes
Restructuring release notes and migration notes. Adding placeholder for v2.x.x migration notes. Signed-off-by: Tommi Rantanen <tommi.rantanen@nordicsemi.no>
1 parent 258d067 commit d7671be

6 files changed

Lines changed: 45 additions & 16 deletions

File tree

doc/index.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,4 @@ It includes host examples in the form of the |SM| AT Client library and the |SM|
1616
app/at_commands
1717
uart_configuration
1818
samples/README
19-
migration_notes
20-
release_notes
19+
releases/releases

doc/releases/migration_notes.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Migration notes
2+
###############
3+
4+
Migration notes for the |SM| to assist user's transition from the previous releases.
5+
6+
.. toctree::
7+
:maxdepth: 1
8+
:caption: Subpages:
9+
10+
migration_notes_v2.0.0
11+
migration_notes_ncs_slm_v3.1.x

doc/migration_notes.rst renamed to doc/releases/migration_notes_ncs_slm_v3.1.x.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _migration_3.1.x_SM:
22

3-
Migration notes
4-
###############
3+
Migration notes from |NCS| v3.1.x SLM
4+
#####################################
55

66
.. contents::
77
:local:
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Migration notes for |SM| v2.0.0 (working draft)
2+
###############################################
3+
4+
.. contents::
5+
:local:
6+
:depth: 3
7+
8+
This document provides guidance for migrating from |SM| v1.x.x to v2.0.0.
9+
The general principle has been to keep v2.0.0 backwards compatible.
10+
However, a small number of changes have been introduced to reduce both maintenance and flash usage. Some of these modifications might not require any updates on the host side, even if corresponding features are in use.
11+
12+
Required changes
13+
****************
14+
15+
The following changes are mandatory to make your application work in the same way as in previous releases.
16+
17+
No changes since the latest release.
Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,5 @@
1-
.. _serial_modem_release_notes:
2-
3-
Release notes
4-
#############
5-
6-
.. contents::
7-
:local:
8-
:depth: 2
9-
10-
For all the notable changes to the |SM|, see the `release on GitHub <github_release_>`_.
11-
121
Release artifacts
13-
*****************
2+
#################
143

154
The |SM| repository contains the following release artifacts:
165

doc/releases/releases.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _serial_modem_release_notes:
2+
3+
Release notes
4+
#############
5+
6+
For all the notable changes to the |SM|, see the `releases on GitHub <github_release_>`_.
7+
8+
.. toctree::
9+
:maxdepth: 2
10+
:caption: Subpages:
11+
12+
release_artifacts
13+
migration_notes

0 commit comments

Comments
 (0)