Skip to content

Commit eae8d27

Browse files
RobertGalatNordictotyz
authored andcommitted
doc: apply review comments
add self section to west.yml Signed-off-by: Robert Gałat <[email protected]>
1 parent e75e6a2 commit eae8d27

File tree

4 files changed

+52
-43
lines changed

4 files changed

+52
-43
lines changed

doc/releases_and_migration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ See information about the latest release notes and the available migration guide
2525

2626
releases_and_migration/migration_guide_v280.rst
2727
releases_and_migration/migration_guide_v260.rst
28-
releases_and_migration/migration_guide_standalone.rst
28+
releases_and_migration/migration_guide_addon_v010.rst

doc/releases_and_migration/migration_guide_standalone.rst renamed to doc/releases_and_migration/migration_guide_addon_v010.rst

Lines changed: 34 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
.. _migration_guide_standalone:
1+
.. _migration_guide_addon_v010:
22

3-
Migration Guide: Moving from NCS Manifest to Standalone west.yml
4-
###############################################################
3+
Migration Guide for moving to Sidewalk Add-on
4+
############################################
55

66
This guide explains how to migrate your Sidewalk development environment from using the NCS manifest to the new standalone west.yml setup.
77

@@ -23,46 +23,54 @@ Before starting the migration, ensure you have:
2323
Migration Steps
2424
=============
2525

26-
1. Clone the New Sidewalk Repository
27-
----------------------------------
26+
1. Initialize Sidewalk Repository
27+
-------------------------------
2828

29-
.. code-block:: console
29+
There are three ways to initialize the Sidewalk repository:
3030

31-
# Clone the new Sidewalk repository into sidewalk directory
32-
git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
31+
.. tabs::
3332

34-
2. Clean Existing West Configuration (if applicable)
35-
-------------------------------------------------
33+
.. tab:: Option 1: Direct Initialization (Recommended)
3634

37-
If you already have an NCS setup with Sidewalk, you need to remove the existing west configuration and ensure Sidewalk is checked out to the correct revision after the NCS separation:
35+
.. code-block:: console
3836
39-
.. code-block:: console
37+
# Initialize west with the remote manifest
38+
west init -m https://github.com/nrfconnect/sdk-sidewalk
4039
41-
# Remove the .west directory to clean the west configuration
42-
rm -rf .west
43-
# Checkout and pull main branch in Sidewalk repository
44-
cd sidewalk
45-
git checkout main
46-
git pull origin main
47-
cd ..
40+
.. tab:: Option 2: Manual Clone and Initialize
4841

49-
3. Initialize West
50-
-----------------
42+
.. code-block:: console
5143
52-
.. code-block:: console
44+
# Clone the Sidewalk repository into sidewalk directory
45+
git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
46+
# Initialize west with local manifest
47+
west init -l sidewalk
5348
54-
# Initialize west with the new manifest
55-
west init -l sidewalk
49+
.. tab:: Option 3: Clean Existing Configuration
50+
51+
If you already have an NCS setup with Sidewalk, you need to remove the existing west configuration first:
52+
53+
.. code-block:: console
54+
55+
# Remove the .west directory to clean the west configuration
56+
rm -rf .west
57+
# Checkout and pull main branch in Sidewalk repository
58+
cd sidewalk
59+
git checkout main
60+
git pull origin main
61+
cd ..
62+
# Initialize west with local manifest
63+
west init -l sidewalk
5664
57-
4. Update Repositories
65+
2. Update Repositories
5866
---------------------
5967

6068
.. code-block:: console
6169
6270
# Update all repositories
6371
west update
6472
65-
5. Update Toolchain and Install Dependencies
73+
3. Update Toolchain and Install Dependencies
6674
------------------------------------------
6775

6876
.. code-block:: console

doc/setting_up_sidewalk_environment/setting_up_sdk.rst

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,30 +16,28 @@ Setting up the Sidewalk Repository
1616
***********************************
1717

1818
The Sidewalk repository is now managed through its own west.yml configuration. To set up the Sidewalk development environment:
19+
There are two ways to initialize the Sidewalk repository:
1920

20-
1. Clone the Sidewalk repository:
21+
.. tabs::
2122

22-
.. code-block:: console
23-
24-
git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
23+
.. tab:: Option 1: Direct Initialization (Recommended)
2524

26-
2. If you are migrating from an existing NCS setup with Sidewalk, clean the west configuration:
25+
.. code-block:: console
2726
28-
.. code-block:: console
27+
# Initialize west with the remote manifest
28+
west init -m https://github.com/nrfconnect/sdk-sidewalk
2929
30-
# Remove the .west directory to clean the west configuration
31-
rm -rf .west
32-
# Checkout and pull main branch in Sidewalk repository
33-
cd sidewalk
34-
git checkout main
35-
git pull origin main
36-
cd ..
30+
.. tab:: Option 2: Manual Clone and Initialize
3731

38-
3. Initialize west with the new manifest:
32+
.. code-block:: console
3933
40-
.. code-block:: console
34+
# Clone the Sidewalk repository into sidewalk directory
35+
git clone https://github.com/nordicsemiconductor/sidewalk.git sidewalk
36+
# Initialize west with local manifest
37+
west init -l sidewalk
4138
42-
west init -l sidewalk
39+
.. note::
40+
If you are migrating from an existing NCS setup with Sidewalk, please refer to the :ref:`migration_guide_addon_v010` for detailed migration steps.
4341

4442
4. Update all repositories:
4543

west.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,6 @@ manifest:
1515
repo-path: sdk-nrf
1616
revision: 10dd3ddbf2560aba2da99a2dc2536b177a1498d7
1717
import: true
18+
19+
self:
20+
path: sidewalk

0 commit comments

Comments
 (0)