Skip to content

Commit

Permalink
docs: Apply suggestions from code review.
Browse files Browse the repository at this point in the history
  • Loading branch information
Pauiii committed Oct 25, 2024
1 parent 16d399d commit 63e14a7
Showing 1 changed file with 2 additions and 11 deletions.
13 changes: 2 additions & 11 deletions docs/docs/development/local-toolchain/setup/container.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ git clone https://github.com/zmkfirmware/zmk.git

## Creating Volumes

In case you have a `zmk-config` or want to build with additional modules, it is
necessary to first make them available by creating volumes.
To build from a `zmk-config` or with additional modules, it is necessary to
first make them available by creating volumes.

<Tabs
groupId="container"
Expand Down Expand Up @@ -105,13 +105,11 @@ necessary to first make them available by creating volumes.
</TabItem>
</Tabs>

:::tip
Once this is done, you can refer to the `zmk-config` with
`/workspace/zmk-config` and `/workspace/zmk-modules` to the modules instead of
using their full path like it is shown in the
[build commands](../build-flash.mdx), since these are the locations they were
mounted to in the container.
:::

:::note
When changing the configuration or modules directory, new volumes have to be
Expand Down Expand Up @@ -257,17 +255,10 @@ west init -l app/ # Initialization
west update # Update modules
```

:::tip
This step pulls down quite a bit of tooling, be patient!
:::

:::note
If you are using a Docker-based approach, you have to restart the container at
this point. Stopping it is possible with these commands.

```sh
docker ps # List containers
docker stop "<container-id>" # Stop the container
```

:::

0 comments on commit 63e14a7

Please sign in to comment.