Skip to content

doc: Restructure release and migration notes #232

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

Merged
trantanen merged 1 commit into from
Mar 26, 2026
Merged

doc: Restructure release and migration notes #232

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
3 changes: 1 addition & 2 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@ It includes host examples in the form of the |SM| AT Client library and the |SM|
app/at_commands
uart_configuration
samples/README
migration_notes
release_notes
releases/releases
11 changes: 11 additions & 0 deletions doc/releases/migration_notes.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Migration notes
###############

Migration notes for the |SM| to assist user's transition from the previous releases.

.. toctree::
:maxdepth: 1
:caption: Subpages:

migration_notes_v2.0.0
migration_notes_ncs_slm_v3.1.x
4 changes: 2 additions & 2 deletions doc/migration_notes.rst → ...leases/migration_notes_ncs_slm_v3.1.x.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _migration_3.1.x_SM:

Migration notes
###############
Migration notes from |NCS| v3.1.x SLM
#####################################
Comment thread
trantanen marked this conversation as resolved.

.. contents::
:local:
Expand Down
18 changes: 18 additions & 0 deletions doc/releases/migration_notes_v2.0.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Migration notes for |SM| v2.0.0 (working draft)
###############################################

.. contents::
:local:
:depth: 3

This document provides guidance for migrating from |SM| v1.x.x to v2.0.0.
The general principle has been to keep v2.0.0 backwards compatible.
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.

Required changes
****************

The following changes are mandatory to make your application work in the same way as in previous releases.

No changes since the latest release.
13 changes: 1 addition & 12 deletions doc/release_notes.rst → doc/releases/release_artifacts.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,5 @@
.. _serial_modem_release_notes:

Release notes
#############

.. contents::
:local:
:depth: 2

For all the notable changes to the |SM|, see the `release on GitHub <github_release_>`_.

Release artifacts
*****************
#################

The |SM| repository contains the following release artifacts:

Expand Down
13 changes: 13 additions & 0 deletions doc/releases/releases.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. _serial_modem_release_notes:

Release notes
#############

For all the notable changes to the |SM|, see the `releases on GitHub <github_release_>`_.

.. toctree::
:maxdepth: 2
:caption: Subpages:

release_artifacts
migration_notes
Loading