Skip to content

Commit 6ce88fc

Browse files
pfeerickclaude
andauthored
docs: fix callouts, wiki references, and improve hardware pages (#7204)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 2480604 commit 6ce88fc

22 files changed

Lines changed: 418 additions & 398 deletions

.gitignore

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,4 @@ _wasi_sdk_fetch
2323
*.pyc
2424

2525
# MkDocs
26-
site/
27-
.cache/
26+
/site/

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ EdgeTX is the cutting edge of OpenTX. It is the place where innovative ideas and
4343

4444
- Sound Packs: [Info](https://github.com/EdgeTX/edgetx-sdcard-sounds) - [Downloads](https://github.com/EdgeTX/edgetx-sdcard-sounds/releases)
4545

46-
- [Development Wiki](https://github.com/EdgeTX/edgetx/wiki) - [Docker Build Environment](https://github.com/EdgeTX/build-edgetx)
46+
- [Developer Documentation](https://edgetx.org/edgetx/latest/) - [Docker Build Environment](https://github.com/EdgeTX/build-edgetx)
4747

4848

4949
## Acknowledgements

docs/README.md

Lines changed: 71 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
# EdgeTX Developer Documentation
2+
3+
This folder contains the source for the EdgeTX developer documentation site, built with [MkDocs](https://www.mkdocs.org/) using the [Material theme](https://squidfunk.github.io/mkdocs-material/).
4+
5+
## Prerequisites
6+
7+
Install the required packages from the repo root. Using [`uv`](https://docs.astral.sh/uv/getting-started/installation/) is recommended:
8+
9+
```bash
10+
uv pip install -r docs-requirements.txt
11+
```
12+
13+
Or with plain pip:
14+
15+
```bash
16+
pip install -r docs-requirements.txt
17+
```
18+
19+
[`mike`](https://github.com/jimporter/mike) is included as a dependency — it manages versioned deployments of the site (e.g. publishing a new release). You won't need it for local editing or preview.
20+
21+
## Local preview
22+
23+
Serve the docs locally with live reload:
24+
25+
```bash
26+
mkdocs serve
27+
```
28+
29+
Then open [http://127.0.0.1:8000](http://127.0.0.1:8000) in your browser. The site will automatically refresh as you edit files.
30+
31+
## Building
32+
33+
To build a static copy of the site into the `site/` directory:
34+
35+
```bash
36+
mkdocs build
37+
```
38+
39+
CI runs `mkdocs build --strict` on pull requests, which treats warnings (e.g. broken internal links) as errors. It's worth running this locally before submitting a PR to catch any issues early:
40+
41+
```bash
42+
mkdocs build --strict
43+
```
44+
45+
## Deployment
46+
47+
The docs are deployed automatically via GitHub Actions (`.github/workflows/docs.yml`):
48+
49+
- Pushes to `main` are deployed as the `latest` version.
50+
- Release tags (e.g. `v2.11.0`) are deployed as a numbered version (e.g. `v2.11`) and aliased as `stable`.
51+
52+
## Project structure
53+
54+
```
55+
docs/
56+
├── assets/ # Images, stylesheets
57+
├── building/ # Build guides (Windows, Linux, macOS, CodeSpaces)
58+
├── contributing/ # Git workflow and contribution guides
59+
├── development/ # Developer reference (CLI, protocols, etc.)
60+
├── hardware/ # Radio specs and hardware reference
61+
├── mods/ # Hardware modification guides
62+
└── troubleshooting/ # Troubleshooting guides
63+
```
64+
65+
Site navigation is defined in [`mkdocs.yml`](../mkdocs.yml) at the repo root.
66+
67+
## Adding or editing pages
68+
69+
1. Create or edit a `.md` file in the appropriate subfolder.
70+
2. If adding a new page, add it to the `nav:` section in `mkdocs.yml`.
71+
3. Preview with `mkdocs serve` and verify with `mkdocs build --strict` before submitting a PR.

docs/assets/simu_x9dplus_ubuntu

14.5 MB
Binary file not shown.

docs/building/codespaces.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@ Next, issue:
4343
cmake --build . --target arm-none-eabi-configure --parallel 2
4444
```
4545

46-
> [!NOTE]
47-
> The `--parallel 2` in the command above instructs the cmake build system as to how many tasks to execute in parallel. Typically, you would set this to the number of CPU cores your machine has. So if you are using a higher CPU core count GitHub machine type, you can increase this to suit, and get a faster build.
46+
!!! note
47+
The `--parallel 2` in the command above instructs the cmake build system as to how many tasks to execute in parallel. Typically, you would set this to the number of CPU cores your machine has. So if you are using a higher CPU core count GitHub machine type, you can increase this to suit, and get a faster build.
4848

4949
Only a few seconds later, you should be greeted with "-- Generating done" message.
5050

@@ -55,8 +55,8 @@ cmake --build arm-none-eabi --target firmware
5555

5656
This time it can take few minutes so until the firmware binary is successfully built. If you see "[100%] Built target firmware" then all went smoothly, and you have just made yourself a custom EdgeTX firmware. If you are making incremental modifications to the firmware, subsequent firmware builds will be a lot faster.
5757

58-
> [!TIP]
59-
> If you want more information about the firmware binary - such as how big the firmware is in relation to the FLASH memory the target handset has, you can compile the `firmware-size` target instead of firmware, and you'll get a summary at the end of the firmware build.
58+
!!! tip
59+
If you want more information about the firmware binary - such as how big the firmware is in relation to the FLASH memory the target handset has, you can compile the `firmware-size` target instead of firmware, and you'll get a summary at the end of the firmware build.
6060

6161
It's a good idea to rename the binary, so that it is easier later to see the target radio and which options were baked into it. For this, issue in the terminal:
6262
```
@@ -66,6 +66,6 @@ mv firmware.bin edgetx_main_tx16s_bt_release.bin
6666

6767
In the left file browser tree open the **build** folder and then open **arm-none-eabi** folder. Right click at _edgetx_main_tx16s_bt_release.bin_ and select Download.
6868

69-
Put the downloaded firmware binary into your radio SD card \FIRMWARE subfolder, and flash it to your radio either using EdgeTX bootloader, [EdgeTX Buddy](https://buddy.edgetx.org/), EdgeTX Companion or [STM32CubeProgrammer](../mods/unbrick.md).
69+
Put the downloaded firmware binary into your radio SD card \FIRMWARE subfolder, and flash it to your radio either using EdgeTX bootloader, [EdgeTX Buddy](https://buddy.edgetx.org/), EdgeTX Companion or [STM32CubeProgrammer](../troubleshooting/unbrick.md).
7070

7171
Use [EdgeTX Buddy](https://buddy.edgetx.org/) or EdgeTX Companion to fill your SD card appropriately for your radio.

0 commit comments

Comments
 (0)