Skip to content

Commit 5fe962a

Browse files
committed
revamped board support page
1 parent 5897a80 commit 5fe962a

2 files changed

Lines changed: 19 additions & 9 deletions

File tree

docs/board-support/ST/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@ has_children: true
99

1010
STMicroelectronics development boards offer an excellent platform for working with the Ocre runtime. This section covers our currently supported ST boards and the recommended development tools for working with them.
1111

12-
## Recommended Tools
13-
* **[STM32CubeProg](https://www.st.com/en/development-tools/stm32cubeprog.html)**: Official programming utility for flashing and configuring STM32 devices
14-
* **[STM32CubeIDE](https://www.st.com/en/development-tools/stm32cubeide.html)**: Integrated development environment that combines STM32CubeMX and STM32CubeProg functionalities with a full-featured code editor and debugger
12+
## Required Tools
13+
Before working with any STM32 board, you must install:
14+
* **[STM32CubeProgrammer](https://www.st.com/en/development-tools/stm32cubeprog.html)**: Official programming utility required for flashing firmware and configuring STM32 devices.
1515

16-
For board-specific setup instructions and features, please refer to the individual board pages below.
16+
## Supported Boards
17+
Select your board below for detailed setup and usage instructions.

docs/board-support/index.md

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,26 @@ layout: default
44
has_children: true
55
nav_order: 6
66
---
7-
87
# Board Support
9-
The Ocre runtime supports various development boards, each offering different features and capabilities. Each board's documentation provides:
8+
The Ocre runtime supports various development boards, each offering different features and capabilities.
9+
10+
---
11+
12+
## Using this Documentation
13+
1. First, select your board's manufacturer in the **sidebar** to review required tools and setup instructions specific to that manufacturer's development boards
14+
2. After installing the necessary tools, find your specific board's documentation for detailed hardware setup and flashing instructions
15+
16+
**Each board's documentation provides:**
1017
- Hardware specifications and features
1118
- Connection and setup instructions
1219
- Flashing procedures
1320
- Reset and recovery steps
1421
- Relevant board documentation links
1522

16-
Select your boards manufacturer in the **sidebar** to the left, and subsequently your specific board for detailed setup and usage instructions for your board.
23+
{: .important}
24+
Make sure to review and install all required tools outlined in the manufacturer's page before proceeding to your specific board's instructions. For example, STMicroelectronics boards require STM32CubeProgrammer for flashing firmware.
25+
26+
---
1727

1828
## Adding Board Support
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.
20-
I've:
29+
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.

0 commit comments

Comments
 (0)