From bf9ebd304c6621673d7c684eb7c874e7dd55540d Mon Sep 17 00:00:00 2001 From: Tommi Rantanen Date: Wed, 25 Mar 2026 13:56:09 +0200 Subject: [PATCH] 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 --- doc/index.rst | 3 +-- doc/releases/migration_notes.rst | 11 +++++++++++ .../migration_notes_ncs_slm_v3.1.x.rst} | 4 ++-- doc/releases/migration_notes_v2.0.0.rst | 18 ++++++++++++++++++ .../release_artifacts.rst} | 13 +------------ doc/releases/releases.rst | 13 +++++++++++++ 6 files changed, 46 insertions(+), 16 deletions(-) create mode 100644 doc/releases/migration_notes.rst rename doc/{migration_notes.rst => releases/migration_notes_ncs_slm_v3.1.x.rst} (99%) create mode 100644 doc/releases/migration_notes_v2.0.0.rst rename doc/{release_notes.rst => releases/release_artifacts.rst} (88%) create mode 100644 doc/releases/releases.rst diff --git a/doc/index.rst b/doc/index.rst index fac68878..b279766a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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 diff --git a/doc/releases/migration_notes.rst b/doc/releases/migration_notes.rst new file mode 100644 index 00000000..3b067a8a --- /dev/null +++ b/doc/releases/migration_notes.rst @@ -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 diff --git a/doc/migration_notes.rst b/doc/releases/migration_notes_ncs_slm_v3.1.x.rst similarity index 99% rename from doc/migration_notes.rst rename to doc/releases/migration_notes_ncs_slm_v3.1.x.rst index 7cff4f27..3248e66d 100644 --- a/doc/migration_notes.rst +++ b/doc/releases/migration_notes_ncs_slm_v3.1.x.rst @@ -1,7 +1,7 @@ .. _migration_3.1.x_SM: -Migration notes -############### +Migration notes from |NCS| v3.1.x SLM +##################################### .. contents:: :local: diff --git a/doc/releases/migration_notes_v2.0.0.rst b/doc/releases/migration_notes_v2.0.0.rst new file mode 100644 index 00000000..f20e8a0e --- /dev/null +++ b/doc/releases/migration_notes_v2.0.0.rst @@ -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. diff --git a/doc/release_notes.rst b/doc/releases/release_artifacts.rst similarity index 88% rename from doc/release_notes.rst rename to doc/releases/release_artifacts.rst index f0db0d87..30234071 100644 --- a/doc/release_notes.rst +++ b/doc/releases/release_artifacts.rst @@ -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 `_. - Release artifacts -***************** +################# The |SM| repository contains the following release artifacts: diff --git a/doc/releases/releases.rst b/doc/releases/releases.rst new file mode 100644 index 00000000..68566f54 --- /dev/null +++ b/doc/releases/releases.rst @@ -0,0 +1,13 @@ +.. _serial_modem_release_notes: + +Release notes +############# + +For all the notable changes to the |SM|, see the `releases on GitHub `_. + +.. toctree:: + :maxdepth: 2 + :caption: Subpages: + + release_artifacts + migration_notes