Skip to content

Commit 5897a80

Browse files
committed
moved dev environment stuff, fixed a lot of broken links
1 parent 782a2d5 commit 5897a80

25 files changed

Lines changed: 44 additions & 110 deletions

.lycheeignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,9 @@
1111
# Example:
1212
# https://example.com/specific-page
1313
# *.example.com/*
14+
15+
# Ignore localhost
1416
http://localhost:4000/
17+
18+
# For some reason st times out on all pages. Will need to fix this in the future
19+
https://www.st.com

docs/board-support/ST/B-U585I-IOT02A/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ The device will appear as a USB serial port when properly connected. On Linux/ma
5454

5555
## Flashing the Firmware
5656

57-
To flash the Ocre runtime, please follow the steps in the [Using a Physical Device](../../../quickstart/firmware/hardware) section found in the [Building and Flashing the Ocre Runtime](../../../quickstart/firmware/index) guide.
57+
To flash the Ocre runtime, please follow the steps in the [Using a Physical Device](../../../quickstart/firmware/hardware) section found in the [Building and Flashing the Ocre Runtime](../../../quickstart/firmware) guide.
5858

5959
{: .note}
6060
Be sure to use `b_u585i_iot02a` as your board name.

docs/board-support/ST/NUCLEO-H723ZG/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ The device will appear as a USB serial port when properly connected. On Linux/ma
5656

5757
## Flashing the Firmware
5858

59-
To flash the Ocre runtime, please follow the steps in the [Using a Physical Device](../../../quickstart/firmware/hardware) section found in the [Building and Flashing the Ocre Runtime](../../../quickstart/firmware/index) guide.
59+
To flash the Ocre runtime, please follow the steps in the [Using a Physical Device](../../../quickstart/firmware/hardware) section found in the [Building and Flashing the Ocre Runtime](../../../quickstart/firmware) guide.
6060

6161
{: .note}
6262
Be sure to use `nucleo_h723zg` as your board name.

docs/board-support/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ The Ocre runtime supports various development boards, each offering different fe
1616
Select your boards manufacturer in the **sidebar** to the left, and subsequently your specific board for detailed setup and usage instructions for your board.
1717

1818
## Adding Board Support
19-
If your board isn't listed in our supported devices, check out the [Adding Board Support](../board-support/adding-support/index) guide in the sidebar. This guide walks you through the process of adding support for new development boards to the Ocre runtime.
19+
If your board isn't listed in our supported devices, check out the [Adding Board Support](../board-support/adding-support) guide in the sidebar. This guide walks you through the process of adding support for new development boards to the Ocre runtime.
2020
I've:

docs/quickstart/firmware/hardware.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ nav_order: 1
99

1010
This guide covers building and flashing the Ocre runtime onto actual development boards. While simulated environments are great for initial testing, deploying to real hardware allows you to test your applications under authentic conditions and take advantage of board-specific features like sensors and networking capabilities.
1111

12-
Please refer to the board-specific documentation in our [Board Support](../../../board-support) section for detailed setup instructions and requirements for your board before attempting to flash Ocre.
12+
Please refer to the board-specific documentation in our [Board Support](../../board-support) section for detailed setup instructions and requirements for your board before attempting to flash Ocre.
1313

1414
---
1515

@@ -20,7 +20,7 @@ Please refer to the board-specific documentation in our [Board Support](../../..
2020
Complete the [Install dependencies](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-dependencies) and the [Install the Zephyr SDK](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-the-zephyr-sdk) sections for your host operating system from the Zephyr (v3.7.0) [Getting Started Guide](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#getting-started-guide).
2121

2222
{: .note}
23-
Currently the Ocre runtime is built on Zephyr `3.7.0`. As a result, the links in the above section reference `v3.7.0` documentation and not the *latest* documentation. It is advised to follow the links in this guide to ensure compability with your device.
23+
Currently the Ocre runtime is built on Zephyr `3.7.0`. As a result, the links in the above section reference `v3.7.0` documentation and not the *latest* documentation. It is advised to follow the links in this guide to ensure compatibility with your device.
2424

2525
### **2. Install WEST**
2626

@@ -37,7 +37,7 @@ We recommend using a Python virtual environment like [venv](https://docs.python.
3737

3838
Next, we will prepare the Zephyr workspace and checkout the project code.
3939

40-
First, create the `runtime` directory in the location of your chosing.
40+
First, create the `runtime` directory in the location of your choosing.
4141
```
4242
mkdir runtime
4343
```
@@ -94,4 +94,4 @@ After flashing, restart/reset your board to run the application.
9494
## Troubleshooting
9595
This section covers common issues you might encounter when building and flashing the Ocre runtime to physical hardware, along with their solutions.
9696

97-
- **Unsupported Board**: If you're unable to flash to your board, and it's not listed in our [supported boards](../../../board-support), check out our [Adding Board Support](../../../board-support/adding-support) guide under the Board Support section. This guide will walk you through the process of adding support for your specific hardware.
97+
- **Unsupported Board**: If you're unable to flash to your board, and it's not listed in our [supported boards](../../board-support), check out our [Adding Board Support](../../board-support/adding-support) guide under the Board Support section. This guide will walk you through the process of adding support for your specific hardware.

docs/quickstart/firmware/simulated.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ This guide covers building and running the Ocre runtime using Zephyr's `native_s
1616
> 2. The POSIX architecture does not work on macOS due to fundamental differences between macOS and other Unix-like operating systems.
1717
>
1818
> For users affected by these limitations, we recommend using one of the following alternatives:
19-
> - A Linux-based x86_64 development container. (Feel free to use the [Ocre Dev Container](../../prerequisites/dev-environment/index) you obtained when setting up your dev environment.)
19+
> - A Linux-based x86_64 development container. (Feel free to use the [Ocre Dev Container](../first-app/dev-environment) you obtained when setting up your dev environment.)
2020
> - A computer with a x86_64 architecture
2121
> - Emulating a Linux-based VM with x86_64 architecture
2222
@@ -29,7 +29,7 @@ This guide covers building and running the Ocre runtime using Zephyr's `native_s
2929
Complete the [Install dependencies](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-dependencies) and the [Install the Zephyr SDK](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#install-the-zephyr-sdk) sections for your host operating system from the Zephyr (v3.7.0) [Getting Started Guide](https://docs.zephyrproject.org/3.7.0/develop/getting_started/index.html#getting-started-guide).
3030

3131
{: .note}
32-
Currently the Ocre runtime is built on Zephyr `3.7.0`. As a result, the links in the above section reference `v3.7.0` documentation and not the *latest* documentation. It is advised to follow the links in this guide to ensure compability with your device.
32+
Currently the Ocre runtime is built on Zephyr `3.7.0`. As a result, the links in the above section reference `v3.7.0` documentation and not the *latest* documentation. It is advised to follow the links in this guide to ensure compatibility with your device.
3333

3434
### **2. Install WEST**
3535

@@ -46,7 +46,7 @@ We recommend using a Python virtual environment like [venv](https://docs.python.
4646

4747
Next, we will prepare the Zephyr workspace and checkout the project code.
4848

49-
First, create the `runtime` directory in the location of your chosing.
49+
First, create the `runtime` directory in the location of your choosing.
5050
```
5151
mkdir runtime
5252
```

docs/quickstart/prerequisites/dev-environment/index.md renamed to docs/quickstart/first-app/dev-environment/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
---
22
title: Setting Up Your Development Environment
33
layout: default
4-
parent: Prerequisites
5-
nav_order: 1
6-
has_toc: true
4+
parent: Your First App
5+
nav_order: 0
76
---
87

98
# Setting Up Your Development Environment
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Creating Your First App
3+
layout: default
4+
parent: Your First App
5+
nav_order: 1
6+
---

docs/quickstart/first-app/index.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,21 @@ layout: default
44
parent: Quickstart
55
nav_order: 3
66
has_children: true
7-
---
7+
---
8+
9+
# Your First App
10+
11+
This section guides you through creating your first containerized application with Ocre. You'll set up a development environment and build a simple application that demonstrates Ocre's core capabilities.
12+
13+
---
14+
15+
## Getting Started
16+
17+
Begin by following our [Setting Up Your Development Environment](./dev-environment) guide to install and configure the necessary tools. This guide offers two approaches:
18+
- Using Visual Studio Code with Dev Containers for an integrated IDE experience
19+
- Using Docker interactively for a command-line workflow
20+
21+
Once your environment is ready, proceed to [Creatig Your First App](./first-container) to create your first Ocre application.
22+
23+
{: .note}
24+
While we recommend using our Docker-based development environment for consistency, experienced developers can also set up their own toolchain using the required components detailed in our documentation.

docs/quickstart/prerequisites/index.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ has_children: true
1010

1111
What you’ll need to get started:
1212
1. A **Computer** running Windows, Mac or Linux with [Git](https://github.com/git-guides/install-git) and a [serial console](../prerequisites/serial-console) installed.
13-
2. **Development Board** (See the [supported boards](../../reference/board-support/index.md) list).
13+
2. **Development Board** (See the [supported boards](../../board-support) list).
1414
3. **USB Cable** for your development board.
15-
4. Set up your [development environment](../prerequisites/dev-environment).
1615

17-
Once the prerequisites are complete, proceed to the [Building and Flashing the Ocre Runtime](../firmware/index.md) section to build and install the Ocre runtime.
16+
Once the prerequisites are complete, proceed to the [Building and Flashing the Ocre Runtime](../firmware) section to build and install the Ocre runtime.

0 commit comments

Comments
 (0)