Skip to content

Commit 418b648

Browse files
greg-fernordicjm
authored andcommitted
doc: install_ncs: nRFVSC on Open VSX Registry
Updated documentation with information about nRFVSC being available on the Open VSX Registry website. Edited how nRFVSC is referred to in the docs. VSC-3067. Signed-off-by: Grzegorz Ferenc <[email protected]>
1 parent f5ece32 commit 418b648

39 files changed

+103
-82
lines changed

applications/nrf5340_audio/doc/building.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You can build and program the applications in one of the following ways:
1616
* :ref:`nrf53_audio_app_building_standard` - Using this method requires building and programming each development kit separately.
1717

1818
.. important::
19-
Building and programming using the |nRFVSC| is currently not supported.
19+
Building and programming using |nRFVSC| is currently not supported.
2020

2121
.. note::
2222
You might want to check the :ref:`nRF5340 Audio application known issues <known_issues_nrf5340audio>` before building and programming the applications.

doc/nrf/app_dev/config_and_build/building.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ Building an application
1010
|application_sample_definition|
1111

1212
After you have :ref:`created an application <create_application>`, you need to build it in order to be able to program it.
13-
Just as for creating the application, you can build the application using either the |nRFVSC| or the command line.
13+
Just as for creating the application, you can build the application using either |nRFVSC| or the command line.
1414

1515
.. tabs::
1616

1717
.. group-tab:: nRF Connect for VS Code
1818

19-
To build with the |nRFVSC|, you first need to create a build configuration.
19+
To build with |nRFVSC|, you first need to create a build configuration.
2020
For instructions, see `How to build an application`_ in the extension documentation.
2121

2222
By default, the extension runs both stages of the CMake build (:ref:`configuration phase and building phase <app_build_system>`).

doc/nrf/app_dev/config_and_build/cmake/index.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This file is the entry point of the build system as it specifies the application
1414
Maintaining CMakeLists.txt
1515
**************************
1616

17-
The recommended method to maintain and update the :file:`CMakeLists.txt` file is to use the |nRFVSC|.
17+
The recommended method to maintain and update the :file:`CMakeLists.txt` file is to use |nRFVSC|.
1818
The extension provides support for the `source control with west`_ and `CMake build system`_, including `build configuration management <How to work with build configurations_>`_ and `source and config files overview <Details View_>`_.
1919

2020
.. _modifying_files_compiler:
@@ -103,7 +103,7 @@ The following table lists the most common ones used in the |NCS|:
103103
| For applications that *do not* use multiple images, the static configuration can be selected with :makevar:`FILE_SUFFIX` (see above).
104104
- ``-DPM_STATIC_YML_FILE=pm_static_<suffix>.yml``
105105

106-
You can use these parameters in both the |nRFVSC| and the command line.
106+
You can use these parameters in both |nRFVSC| and the command line.
107107

108108
The build variables are applied one after another, based on the order you provide them.
109109
This is how you can specify them:
@@ -148,7 +148,7 @@ Examples of commands
148148

149149
.. group-tab:: nRF Connect for VS Code
150150

151-
To select the build type in the |nRFVSC|:
151+
To select the build type in |nRFVSC|:
152152

153153
1. When `building an application <How to build an application_>`_ as described in the |nRFVSC| documentation, follow the steps for setting up the build configuration.
154154
#. In the **Add Build Configuration** screen, select the desired :file:`.conf` file from the :guilabel:`Configuration` drop-down menu.

doc/nrf/app_dev/config_and_build/config_and_build_system.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,12 @@ The build and configuration system in Zephyr and the |NCS| uses the following bu
3333
- :file:`.dts`, :file:`.dtsi`, :file:`.overlay`
3434
- Hardware description language.
3535
- `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_
36-
- Devicetree Visual Editor is part of the |nRFVSC|. You still need to be familiar with the devicetree language to use it.
36+
- Devicetree Visual Editor is part of |nRFVSC|. You still need to be familiar with the devicetree language to use it.
3737
* - :ref:`Kconfig <zephyr:application-kconfig>`
3838
- :file:`Kconfig`, :file:`prj.conf`, :file:`.config`
3939
- Software configuration system also used in the Linux kernel.
4040
- `Kconfig GUI <Configuring with nRF Kconfig_>`_, :ref:`menuconfig and guiconfig <zephyr:menuconfig>`
41-
- | Kconfig GUI is part of the |nRFVSC|.
41+
- | Kconfig GUI is part of |nRFVSC|.
4242
| The :ref:`Kconfig Reference <configuration_options>` provides the documentation for each configuration option.
4343
* - :ref:`partition_manager`
4444
- :file:`pm.yml`, :file:`pm_static.yml`
@@ -103,7 +103,7 @@ The header file contains the same kind of information, but with defines usable b
103103
For more information, see :ref:`configuring_devicetree` and Zephyr's :ref:`zephyr:dt-guide`.
104104
In particular, :ref:`zephyr:set-devicetree-overlays` explains how the base devicetree files are selected.
105105

106-
In the |NCS|, you can use the |nRFVSC| to `create the devicetree files <How to create devicetree files_>`_ and work with them using the dedicated `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_.
106+
In the |NCS|, you can use |nRFVSC| to `create the devicetree files <How to create devicetree files_>`_ and work with them using the dedicated `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_.
107107
You can also select the devicetree files when :ref:`cmake_options`.
108108

109109
.. _configure_application_sw:

doc/nrf/app_dev/config_and_build/hardware/add_new_led_example.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Adding a dimmable LED node
99

1010
This example demonstrates how to add support for a dimmable LED node to your board in an overlay file.
1111

12-
To implement this example, you can either edit the devicetree files manually or use the |nRFVSC| with its `Devicetree language support`_ and the `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_ (recommended).
12+
To implement this example, you can either edit the devicetree files manually or use |nRFVSC| with its `Devicetree language support`_ and the `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_ (recommended).
1313

1414
For more advanced LED control, you can also use the :ref:`LEDs module <caf_leds>` of the :ref:`Common Application Framework (CAF) <lib_caf>`, which provides additional features, such as LED effects and power management integration.
1515

@@ -33,7 +33,7 @@ Open or create the overlay file to edit
3333
Overlay files are a category of devicetree's :ref:`zephyr:devicetree-in-out-files`.
3434
These files can override node property values in multiple ways.
3535

36-
You can add them to your configuration :ref:`manually <zephyr:set-devicetree-overlays>` or by using the |nRFVSC| (see `How to create devicetree files`_).
36+
You can add them to your configuration :ref:`manually <zephyr:set-devicetree-overlays>` or by using |nRFVSC| (see `How to create devicetree files`_).
3737

3838
.. rst-class:: numbered-step
3939

doc/nrf/app_dev/config_and_build/hardware/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Configuring devicetree
44
######################
55

6-
The |nRFVSC| is the recommended tool for editing :ref:`configure_application_hw`.
6+
|nRFVSC| is the recommended tool for editing :ref:`configure_application_hw`.
77
The extension offers several layers of `Devicetree integration <Devicetree support overview_>`_, ranging from summarizing devicetree settings in a menu and providing devicetree language support in the editor, to the Devicetree Visual Editor, a GUI tool for editing devicetree files.
88
Follow the steps in `How to create devicetree files`_ and use one of the following options to edit the :file:`.dts`, :file:`.dtsi`, and :file:`.overlay` files:
99

doc/nrf/app_dev/config_and_build/hardware/use_gpio_pin_directly.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In the development phase of an embedded project, you can use this configuration
1212
You can use this solution to collect execution timings, or as a debugging tool.
1313

1414
You can copy the following configuration snippets manually into the devicetree overlay files.
15-
You can also use the `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_ (either in GUI or text mode) in the |nRFVSC| to apply them.
15+
You can also use the `Devicetree Visual Editor <How to work with Devicetree Visual Editor_>`_ (either in GUI or text mode) in |nRFVSC| to apply them.
1616

1717
.. rst-class:: numbered-step
1818

doc/nrf/app_dev/config_and_build/kconfig/index.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,21 @@ The resulting configuration is written to the :file:`zephyr/.config` file in you
2222
This means that this file is available when building the application until you clean the build directory pristinely.
2323

2424
.. note::
25-
While it is possible to edit the :file:`.config` file directly, you should use the nRF Kconfig GUI in the |nRFVSC| or a tool like menuconfig or guiconfig to update it.
25+
While it is possible to edit the :file:`.config` file directly, you should use the nRF Kconfig GUI in |nRFVSC| or a tool like menuconfig or guiconfig to update it.
2626
These tools present all available options and allow you to select the ones that you need.
2727
They also show the dependencies between the options and their limitations.
2828

2929
.. tabs::
3030

3131
.. group-tab:: nRF Connect for VS Code
3232

33-
Use the nRF Kconfig GUI in the |nRFVSC| to select the desired options.
33+
Use the nRF Kconfig GUI in |nRFVSC| to select the desired options.
3434
The GUI organizes the Kconfig options in a hierarchical list and lets you view and manage your selection.
3535

3636
To locate a specific configuration option, use the **Search modules** field.
3737
Read the `Configuring with nRF Kconfig`_ page in the |nRFVSC| documentation for more information.
3838

39-
Alternatively, you can configure your application in the |nRFVSC| using menuconfig.
39+
Alternatively, you can configure your application in |nRFVSC| using menuconfig.
4040
Open the **More actions..** menu next to `Kconfig action in the Actions View`_ to start menuconfig in the extension.
4141

4242
.. group-tab:: Command line
@@ -88,7 +88,7 @@ See :ref:`zephyr:setting_configuration_values` in the Zephyr documentation for i
8888

8989
.. group-tab:: nRF Connect for VS Code
9090

91-
If you work with the |nRFVSC|, you can use one of the following options:
91+
If you work with |nRFVSC|, you can use one of the following options:
9292

9393
* Edit the :file:`prj.conf` directly in |VSC|.
9494
* Select an extra Kconfig fragment file when you `build an application <How to build an application_>`_.

doc/nrf/app_dev/config_and_build/sysbuild/sysbuild_images.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -311,8 +311,8 @@ Kconfig.sysbuild:
311311
312312
.. _sysbuild_images_editing_in_nrfvsc:
313313

314-
Editing sysbuild images and domains in the |nRFVSC|
315-
***************************************************
314+
Editing sysbuild images and domains in |nRFVSC|
315+
***********************************************
316316

317-
The |nRFVSC| provides a GUI for editing sysbuild images and domains.
317+
|nRFVSC| provides a GUI for editing sysbuild images and domains.
318318
See the `How to work with sysbuild domains`_ page in the extension documentation for more information.

doc/nrf/app_dev/create_application.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -138,16 +138,16 @@ Creating an |NCS| application
138138
*****************************
139139

140140
The process for creating an |NCS| application depends on the development environment.
141-
Using the |nRFVSC| is the recommended method.
141+
Using |nRFVSC| is the recommended method.
142142

143143
.. note::
144144
No steps are provided for the creation of :ref:`repository applications <create_application_types_repository>`.
145145
Creating repository applications is not recommended, as placing any application in the |NCS| source file structure can corrupt the SDK installation.
146146

147147
.. _creating_vsc:
148148

149-
Creating application in the |nRFVSC|
150-
====================================
149+
Creating application in |nRFVSC|
150+
================================
151151

152152
.. note::
153153
If you prefer, you can `start VS Code walkthrough`_ and create applications and build configurations from there.
@@ -158,10 +158,10 @@ Use the following steps depending on the application placement:
158158

159159
.. group-tab:: Workspace application (recommended)
160160

161-
To create a workspace application in the |nRFVSC|:
161+
To create a workspace application in |nRFVSC|:
162162

163163
1. Open |VSC|.
164-
#. Open the |nRFVSC|.
164+
#. Open |nRFVSC|.
165165
#. In the :guilabel:`Welcome View`, click the :guilabel:`Create a new application` action.
166166
A quick pick menu appears.
167167
#. Choose one of the following options:
@@ -194,10 +194,10 @@ Use the following steps depending on the application placement:
194194

195195
.. group-tab:: Freestanding application
196196

197-
To create a freestanding application in the |nRFVSC|:
197+
To create a freestanding application in |nRFVSC|:
198198

199199
1. Open |VSC|.
200-
#. Open the |nRFVSC|.
200+
#. Open |nRFVSC|.
201201
#. In the :guilabel:`Welcome View`, click the :guilabel:`Create a new application` action.
202202
A quick pick menu appears.
203203
#. Choose one of the following options:
@@ -311,7 +311,7 @@ To create an application from the add-on index, complete the following steps:
311311

312312
.. tab:: nRF Connect for VS Code (recommended)
313313

314-
Complete the following steps in the |nRFVSC|:
314+
Complete the following steps in |nRFVSC|:
315315

316316
1. In the :guilabel:`Welcome View`, click :guilabel:`Create a new application`.
317317
#. Select :guilabel:`Browse nRF Connect SDK Add-on Index`.

0 commit comments

Comments
 (0)