Skip to content
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

doc: 3.0.0-preview1 doc updates #20615

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: 3.0.0-preview1 doc updates #20615

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
4 changes: 2 additions & 2 deletions doc/nrf/dev_model_and_contributions/adding_code.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ This is demonstrated by the following code, that would be placed somewhere in yo
- name: nrf
repo-path: sdk-nrf
remote: ncs
revision: 2.9.0-nRF54H20-1-rc2
revision: 3.0.0-preview1
import: true
self:
path: application
Expand All @@ -189,7 +189,7 @@ For example:
projects:
- name: nrf
remote: ncs
revision: 2.9.0-nRF54H20-1-rc2
revision: 3.0.0-preview1
import: true
# Example for how to override a repository in the nRF Connect SDK with your own:
- name: mcuboot
Expand Down
5 changes: 5 additions & 0 deletions doc/nrf/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
Introduction
############

.. important::

|NCS| v3.0.0-preview1 is a development tag used for development purposes but is not recommended to use in a production environment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
|NCS| v3.0.0-preview1 is a development tag used for development purposes but is not recommended to use in a production environment.
|NCS| v3.0.0-preview1 is a development tag used only for development purposes.

Would this be sufficient?

This tag may be replaced by a release in the future.

The |NCS| is a modern, unified software development kit for building low-power wireless applications based on the Nordic Semiconductor nRF52, nRF53, nRF54, nRF70, and nRF91 Series wireless devices.
It supports :ref:`Microsoft Windows, Linux, and macOS <requirements>` for development.

Expand Down
1 change: 1 addition & 0 deletions doc/nrf/links.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -594,6 +594,7 @@
.. _`Migration guide for nRF Connect SDK v2.6.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.6.html
.. _`Migration guide for nRF Connect SDK v2.5.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_2.5.html
.. _`Migration guide for nRF Connect SDK v2.0.0`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.html
.. _`Migrating from Secure Partition Manager to Trusted Firmware-M`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_guide_spm_to_tf-m.html
.. _`Migrating from multi-image builds to sysbuild`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_sysbuild.html
.. _`Migrating to the current hardware model`: https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/releases_and_maturity/migration/migration_hwmv2.html

Expand Down
1 change: 0 additions & 1 deletion doc/nrf/releases_and_maturity.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,3 @@ If an issue is found in a release after it has taken place, those issues are lis
releases_and_maturity/repository_revisions
releases_and_maturity/software_maturity
releases_and_maturity/abi_compatibility
releases_and_maturity/known_issues
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/known_issues.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _known_issues:

Known issues
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_1.x_to_2.x.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _ncs_2.0.0_migration:

Migration notes for |NCS| v2.0.0
Expand Down
2 changes: 2 additions & 0 deletions ...rf/releases_and_maturity/migration/migration_guide_2.4.99-cs3_to_2.6.99-cs2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_cs3_to_2_6_99_cs2:

Migration notes for |NCS| v2.6.99_cs2 for v2.4.99-cs3 users
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.5.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.5:

Migration guide for |NCS| v2.5.0
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.6:

Migration guide for |NCS| v2.6.0
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.7:

Migration guide for |NCS| v2.7.0
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.8.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.8:

Migration guide for |NCS| v2.8.0
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.9.0-nRF54H20-1-rc2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.9.0-nRF54H20-1-rc2:

Migration guide for |NCS| v2.9.0-nRF54H20-1-rc2
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_2.9.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_2.9:

Migration guide for |NCS| v2.9.0
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_3.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_3.0:

Migration guide for |NCS| v3.0.0 (Working draft)
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7:

Migration notes for |NCS| v2.7.0 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions ...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs1:

Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions ...f/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _migration_nrf54h20_to_2.7.99-cs2:

Migration notes for |NCS| v2.7.99-cs2 and the nRF54H20 DK
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_guide_spm_to_tf-m.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _spm_to_tfm_migration:

Migrating from Secure Partition Manager to Trusted Firmware-M
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_hwmv2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _hwmv1_to_v2_migration:

Migrating to the current hardware model
Expand Down
2 changes: 2 additions & 0 deletions doc/nrf/releases_and_maturity/migration/migration_sysbuild.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
:orphan:

.. _child_parent_to_sysbuild_migration:

Migrating from multi-image builds to sysbuild
Expand Down
22 changes: 16 additions & 6 deletions doc/nrf/releases_and_maturity/migration_guides.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,20 @@ Migration guides are also provided for major functionality updates.
.. note::
|migration_contact_devzone|

.. toctree::
:maxdepth: 1
:glob:
:reversed:
:caption: Subpages:
* `Migrating from multi-image builds to sysbuild`_
* `Migrating to the current hardware model`_
* `Migration guide for nRF Connect SDK v3.0.0`_
* `Migration guide for nRF Connect SDK v2.9.0`_
* `Migration guide for nRF Connect SDK v2.8.0`_
* `Migration guide for nRF Connect SDK v2.7.0`_
* `Migration guide for nRF Connect SDK v2.6.0`_
* `Migration guide for nRF Connect SDK v2.5.0`_
* `Migration guide for nRF Connect SDK v2.0.0`_

migration/*
For nRF54H20-exclusive releases:

* `Migration guide for nRF Connect SDK v2.9.0-nRF54H20-1-rc2`_
* `Migration notes for nRF Connect SDK v2.7.99-cs2 and the nRF54H20 DK`_
* `Migration notes for nRF Connect SDK v2.7.99-cs1 and the nRF54H20 DK`_
* `Migration notes for nRF Connect SDK v2.7.0 for nRF54H20 DK users`_
* `Migration guide for nRF Connect SDK v2.6.99_cs2 for v2.4.99-cs3 users`_
9 changes: 3 additions & 6 deletions doc/nrf/releases_and_maturity/releases/release-notes-changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
.. _ncs_release_notes_changelog:

Changelog for |NCS| v2.9.99
###########################
Changelog for |NCS| v3.0.0-preview1
###################################

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

The most relevant changes that are present on the main branch of the |NCS|, as compared to the latest official release, are tracked in this file.

.. note::
This file is a work in progress and might not cover all relevant changes.
This Changelog reflects the most relevant changes from the latest official release.

.. HOWTO
Expand Down
6 changes: 3 additions & 3 deletions doc/nrf/shortcuts.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

.. ### Versions

.. |release| replace:: v2.9.0-nRF54H20-1-rc2
.. |release_tt| replace:: ``v2.9.0-nRF54H20-1-rc2``
.. |release_number_tt| replace:: ``2.9.0-nRF54H20-1-rc2``
.. |release| replace:: 3.0.0-preview1
.. |release_tt| replace:: ``v3.0.0-preview1``
.. |release_number_tt| replace:: ``3.0.0-preview1``

.. |jlink_ver| replace:: v8.10f
.. |jlink_ver_vsc| replace:: v7.94i
Expand Down
2 changes: 1 addition & 1 deletion doc/versions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[
"2.9.99",
"3.0.0-preview1",
"2.9.0-nRF54H20-1-rc2",
"2.9.0",
"2.8.0",
Expand Down