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: simplify documentation #693

Merged
merged 2 commits into from
Mar 27, 2025
+61 −84
Merged

doc: simplify documentation #693

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be139ab
doc: simplify documentation
ktaborowski Mar 24, 2025
37c6699
doc: setting up sdk with add-on
ktaborowski Mar 26, 2025
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
64 changes: 18 additions & 46 deletions doc/releases_and_migration/migration_guide_addon_v010.rst
View file
Original file line number Diff line number Diff line change
@@ -15,78 +15,39 @@ The Sidewalk release cycle is now separate from the nRF Connect SDK, allowing fo
You can now find Amazon Sidewalk under the `nRF Connect SDK Add-ons`_ index.
This solution enables an alternative setup method using the `nRF Connect for VS Code`_.

Prerequisites
*************

Before you begin the migration process, you must have the following tools installed:

* Git
* Python 3.8 or later
* The `west`_ tool
* `nRF Util`_

Migration steps
***************

To successfully migrate to Amazon Sidewalk Add-on you must choose the migration method.
If you wish to set up a clean repository, follow one of the methods outlined on the :ref:`setting_up_sdk_sidewalk_repository` page.
If you already have an nRF Connect SDK setup with Sidewalk and wish to migrate, you must complete the following steps:

#. Remove the :file:`.west` directory to clean the west configuration.
1. Disable the Sidewalk group in the manifest.

.. code-block:: console
rm -rf .west
west config manifest.group-filter -- "-sidewalk"
#. Checkout and pull main branch in the Sidewalk repository.
#. Set Sidewalk as a workspace application repository.

.. code-block:: console
cd sidewalk
git checkout main
git pull origin main
cd ..
west config manifest.path sidewalk
#. Initialize west with local manifest.

.. code-block:: console
west init -l sidewalk
#. Update all repositories, by running the following command:
#. Update all repositories.

.. code-block:: console
west update
Depending on your connection, the update might take some time.

#. Execute the following commands to get the toolchain hash and download the necessary toolchain:

.. code-block:: console
nrf/scripts/toolchain.py
nrfutil toolchain install --ncs-version $(nrf/scripts/toolchain.py --ncs-version)
#. Install the required Python packages for both nRF Connect SDK and Zephyr by running the following commands:

.. code-block:: console
pip install -r nrf/scripts/requirements.txt
pip install -r zephyr/scripts/requirements.txt
#. Install Python dependencies.

.. code-block:: console
pip install -r requirements.txt
Verification
************

Verify if your migration was successful by completing the following steps:

1. Ensure that all repositories are properly cloned.
#. Ensure that all repositories are properly cloned.

.. code-block:: console
@@ -146,6 +107,17 @@ If you encounter repository conflicts, do the following:
west update
Resolving toolchain mismatch
============================

Execute the following commands to get the toolchain hash and download the necessary toolchain:

.. code-block:: console
nrf/scripts/toolchain.py
nrfutil toolchain install --ncs-version $(nrf/scripts/toolchain.py --ncs-version)
Build errors
============

@@ -154,5 +126,5 @@ If you encounter build errors, ensure the following:
* All dependencies are installed.
* NCS environment is sourced correctly.
* You are using the correct board target.
* Your build evironment is functioning correctly.
* Your build environment is functioning correctly.
To do this, build the `Zephyr's Hello World`_ sample.
81 changes: 43 additions & 38 deletions doc/setting_up_sidewalk_environment/setting_up_sdk.rst
View file
Original file line number Diff line number Diff line change
@@ -8,73 +8,78 @@ Setting up the SDK
:depth: 2

See the compatibility between the versions of Amazon Sidewalk and the nRF Connect SDK by referring to the :ref:`compatibility_matrix`.
Once confirmed, follow the `Installing the nRF Connect SDK`_ instructions.

.. _setting_up_sdk_sidewalk_repository:
Install the nRF Connect SDK
***************************

To work with the Sidewalk add-on, you need to install the nRF Connect SDK, including all its prerequisites and the nRF Connect SDK toolchain.
Follow the `Installing the nRF Connect SDK`_ instructions, but instead of point 4. Get the nRF Connect SDK code, do :ref:`setting_up_sdk_sidewalk_repository` (described below).

Setting up the Sidewalk repository
***********************************

The Sidewalk repository is managed through its own :file:`west.yml` configuration.
.. _setting_up_sdk_sidewalk_repository:

1. Initialize the Sidewalk repository, using one of the following methods:
Get the Sidewalk Add-on code
****************************

.. tabs::
The Sidewalk Add-on is distributed as a Git repository, and is managed through its own west manifest.
The compatible nRF Connect SDK version is specified in the :file:`west.yml` file.

.. tab:: Direct initialization (Recommended)
.. tabs::

a. Initialize west with the remote manifest.
.. group-tab:: nRF Connect for Visual Studio Code

.. code-block:: console
To clone the Sidewalk Add-on code, together with compatible nRF Connect SDK, complete the following steps:

west init -m https://github.com/nrfconnect/sdk-sidewalk
1. Open the nRF Connect extension in Visual Studio Code by clicking its icon in the :guilabel:`Activity Bar`.
#. In the extension's :guilabel:`Welcome View`, click on :guilabel:`Create a new application`.
The list of actions appears in the Visual Studio Code's quick pick.
#. Click :guilabel:`Browse nRF Connect SDK Add-on Index`.
The list of available nRF Connect SDK Add-ons appears in the Visual Studio Code's quick pick.
#. Select :guilabel:`Amazon Sidewalk Add-on`.
#. Select the Add-on version to install.

.. tab:: Manual cloning and initialization
The Add-on and compatible nRF Connect SDK installation starts and it can take several minutes.

a. Clone the Sidewalk repository into the sidewalk directory.
.. group-tab:: Command line

.. code-block:: console
1. Initialize the Sidewalk repository, using one of the following methods:

git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
.. tabs::

#. Initialize west with local manifest.
.. tab:: Direct initialization (Recommended)

.. code-block:: console
a. Initialize west with the remote manifest.

west init -l sidewalk
.. code-block:: console
.. note::
If you are migrating from an existing nRF Connect SDK setup with Sidewalk, refer to the :ref:`migration_guide_addon_v010` for detailed steps.
west init -m https://github.com/nrfconnect/sdk-sidewalk
#. Update all repositories, by running the following command:
.. tab:: Manual cloning and initialization

.. code-block:: console
a. Clone the Sidewalk repository into the sidewalk directory.

west update
.. code-block:: console
Depending on your connection, the update might take some time.
git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
#. Execute the following commands to get the toolchain hash and download the necessary toolchain:
#. Initialize west with local manifest.

.. code-block:: console
.. code-block:: console
nrf/scripts/toolchain.py
nrfutil toolchain install --ncs-version $(nrf/scripts/toolchain.py --ncs-version)
west init -l sidewalk
#. Install the required Python packages for both nRF Connect SDK and Zephyr by running the following commands:
#. Update all repositories, by running the following command:

.. code-block:: console
.. code-block:: console
pip install -r nrf/scripts/requirements.txt
pip install -r zephyr/scripts/requirements.txt
west update
#. Install Python dependencies.
Depending on your connection, the update might take some time.

.. code-block:: console
#. Install Python dependencies.

pip install -r requirements.txt
.. code-block:: console
Extracting nRF Command Line Tools
*********************************
pip install -r sidewalk/requirements.txt
Download the nRF Command Line from the `nRF command line tools`_ page.
To create an application, use Sidewalk: sid_end_device sample hello app as a starting point.