Skip to content

doc: Documentation issue in 'develop/getting_started/index', No command west boards #66599

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.

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

Closed
ssnover opened this issue Dec 16, 2023 · 2 comments
Assignees
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features

Comments

@ssnover
Copy link
Contributor

ssnover commented Dec 16, 2023

Describe the bug
Under "Build the Blinky Sample", the documentation calls out using the command west boards in order to obtain a list of boards supported by Zephyr. However, west does not appear to support that command:

(.venv) ssnover@pop-os:~/.local/opt/zephyr-sdk-0.16.4$ west boards
usage: west [-h] [-z ZEPHYR_BASE] [-v] [-V] <command> ...
west: unknown command "boards"; do you need to run this inside a workspace?

Running west --help shows a list of commands, but also notes that:

Cannot load extension commands; help for them is not available.
(To debug, try: "west manifest --validate".)

The fix became clear when I switched to the workspace directory created earlier. I'd suggest clarifying the docs here to mention that this command must be run inside a specific directory tree. (Perhaps in or beneath the top level directory containing .west?)

Environment

  • Page: develop/getting_started/index
  • Version: main
  • SHA-1: e910409
Copy link

Hi @ssnover! We appreciate you submitting your first issue for our open-source project. 🌟

Even though I'm a bot, I can assure you that the whole community is genuinely grateful for your time and effort. 🤖💙

@henrikbrixandersen henrikbrixandersen added Enhancement Changes/Updates/Additions to existing features area: Documentation labels Dec 19, 2023
@kartben
Copy link
Collaborator

kartben commented May 24, 2025

Closing as won't fix as it's unlikely (but of course possible, but less so IMO now that SDK is "magically" installed by west sdk without leaving the workspace) that the user would not be within the workspace by the time they reach this step in the getting started guide

@kartben kartben closed this as not planned Won't fix, can't repro, duplicate, stale May 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: Documentation Enhancement Changes/Updates/Additions to existing features
Projects
None yet
Development

No branches or pull requests

3 participants