Skip to content

Commit 19e1923

Browse files
committed
minor tweak to note sections
1 parent 52bf193 commit 19e1923

File tree

5 files changed

+16
-8
lines changed

5 files changed

+16
-8
lines changed

docs/architecture/containers/components/webassembly_module/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,5 @@ Ocre containers use [WebAssembly (WASM)](https://webassembly.org/) modules as th
1111

1212
Modules can either be pure WebAssembly or Ahead-of-Time (AOT) compiled binaries optimized for a specific platform target. In general, the Ocre Orchestration Hub will automatically AOT compile modules on-demand based on the architecture of the deployment target. However, there are instances where a pure WASM binary may be preferred.
1313

14-
**Note:** Currently, only a single WASM module is supported per container image. However, we are exploring extending this to support multiple modules and/or components via the WebAssembly Component Model.
14+
{: .note}
15+
Currently, only a single WASM module is supported per container image. However, we are exploring extending this to support multiple modules and/or components via the WebAssembly Component Model.

docs/quickstart/firmware/hardware.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ In order to build the Ocre runtime properly, you'll need to install a few remain
6363
pip install -r zephyr/scripts/requirements.txt
6464
```
6565

66-
**Note:** This step is only possible after updating the repo with `west update`.
67-
6866
### **5. Install the Zephyr SDK**
6967
For the last Zephyr requirement, we must install the SDK.
7068

docs/quickstart/prerequisites/dev-environment/index.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ title: Setting Up Your Development Environment
33
layout: default
44
parent: Prerequisites
55
nav_order: 1
6+
has_toc: true
67
---
78

89
# Setting Up Your Development Environment
@@ -28,7 +29,8 @@ Before you begin, ensure that you have the following tools installed on your dev
2829
2. [Visual Studio Code](https://code.visualstudio.com/): A lightweight but powerful source code editor.
2930
3. [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers): This extension allows you to use Docker containers as development environments within VS Code.
3031

31-
**Note:** The dev container can also be run directly in GitHub via [CodeSpaces](https://docs.github.com/en/codespaces), though you will only be able to build Ocre containers, not load them on your device as the dev container will not have access to your local devices.
32+
{: .note}
33+
The dev container can also be run directly in GitHub via [CodeSpaces](https://docs.github.com/en/codespaces), though you will only be able to build Ocre containers, not load them on your device as the dev container will not have access to your local devices.
3234

3335
### Steps
3436

@@ -44,7 +46,8 @@ Before you begin, ensure that you have the following tools installed on your dev
4446

4547
Once you select the folder, VS Code will reload. If the container does not exist yet, it will automatically create one and clone the sample repository into an isolated container volume. This process may take a few moments, and progress will be displayed in the lower right corner of the VS Code window. After the container is ready, you can open a terminal within VS Code to access the container environment.
4648

47-
**Note**: Additional documentation and a step-by-step guide for working with dev containers can be found [here](https://code.visualstudio.com/docs/remote/containers-tutorial).
49+
{: .note}
50+
Additional documentation and a step-by-step guide for working with dev containers can be found [here](https://code.visualstudio.com/docs/remote/containers-tutorial).
4851

4952
---
5053

@@ -60,4 +63,10 @@ The toolchain container can also be launched and used interactively as follows:
6063
```sh
6164
cd samples
6265
docker run --rm -it -v $(pwd):/home/ocre ocre/ocre-c-toolchain:latest
63-
```
66+
```
67+
---
68+
69+
## Troubleshooting
70+
This section covers common issues you might encounter when setting up your development environment, along with their solutions.
71+
72+
- If you encounter errors opening the dev container, you likely need to authenticate with the GitHub Container Registry. Follow the authentication steps in the [GitHub documentation](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-with-a-personal-access-token-classic).

docs/samples/blinky/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ cmake -DWASI_SDK_DIR=/opt/wasi-sdk -DCMAKE_TOOLCHAIN_FILE=/opt/wamr-sdk/app-sdk/
2828
make
2929
```
3030

31-
**Note:** This will create a container image called `blinky.nbx` that we can then deploy to our device.
31+
This will create a container image called `blinky.nbx` that we can then deploy to our device.
3232

3333
![](BuildBlinky.jpg)
3434

docs/samples/hello-world/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ cmake -DWASI_SDK_DIR=/opt/wasi-sdk -DCMAKE_TOOLCHAIN_FILE=/opt/wamr-sdk/app-sdk/
2828
make
2929
```
3030

31-
**Note:** This will create a container image called `hello-world.nbx` that we can then deploy to our device.
31+
This will create a container image called `hello-world.nbx` that we can then deploy to our device.
3232

3333
![](BuildHelloWorld.jpg)
3434

0 commit comments

Comments
 (0)