Skip to content

doc: Add VSC instructions to the GSG guide#229

Merged
MarkusLassila merged 1 commit into
nrfconnect:mainfrom
divipillai:gsg_vsc
Mar 31, 2026
Merged

doc: Add VSC instructions to the GSG guide#229
MarkusLassila merged 1 commit into
nrfconnect:mainfrom
divipillai:gsg_vsc

Conversation

@divipillai
Copy link
Copy Markdown
Collaborator

Add VSC instructions to the GSG guide.

@divipillai divipillai marked this pull request as ready for review March 25, 2026 07:51
Comment thread doc/gsg_guide.rst Outdated
Comment thread doc/gsg_guide.rst

There are two options for setting up the project, depending on your preferred development environment:

* Using `nRF Connect for VS Code`_ (recommended)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Do we have to recommend this? I would change the order as we have plenty of overlay-files for which the documentation is intended for command line usage.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

We recommend the end users to use VSC - https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/installation/install_ncs.html. If really needed, I can remove the word recommended but I think VSC is given priority over command line. VSC works with overlay-files as well - https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/app_dev/config_and_build/cmake/index.html#providing_cmake_options. I can include those steps (about overlay files).

Copy link
Copy Markdown
Contributor

@MarkusLassila MarkusLassila Mar 25, 2026

Choose a reason for hiding this comment

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

No need to change that. But take a look on how the overlay's are discussed in the documentation and whether that aligns with this. We are giving at least come direct command line compilation commands.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Our company wants to prefer VS Code, I guess. I'd do a compromise and keep the order of the tabs but remove "recommended". But I don't know if we can do that...

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

So do we need to change something? Or can I just merge this?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I plan to add the overlay instructions for VSC. Please wait.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I have added some sentences about how to configure the variables (Kconfig, overlayfiles, etc)..

Add VSC instructions to the GSG guide.

Signed-off-by: divya pillai <divya.pillai@nordicsemi.no>
@MarkusLassila MarkusLassila merged commit 59b80c4 into nrfconnect:main Mar 31, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants