Skip to content

Commit a73dee8

Browse files
wkumikwkumik
authored
Merge pull request #30 from BlackFox-org/main
Fixed missing images, moved Thinker to OpenIPC/VTX, modified guidelines
2 parents 5d61ee6 + f935fd8 commit a73dee8

File tree

7 files changed

+45
-263
lines changed

7 files changed

+45
-263
lines changed

‎src/content/docs/development/contribution-guidelines.md‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,9 +85,19 @@ This guide will walk you through the new feature introduced in the latest releas
8585
For more details, check the [official documentation](https://docs.openipc.org).
8686

8787
This is an image [Example Image](../../../images/example-image.png)
88+
This is an image with unreadable text in a dark theme
89+
(changes the image depending on the selected theme)
90+
<ThemeImage
91+
lightSrc="/src/assets/images/example-image-light.png"
92+
darkSrc="/src/assets/images/example-image-dark.png"
93+
alt="Example image"
94+
/>
8895
```
8996
:::caution
90-
Please place your image in `/src/assets/images`so that you can use it like this `[Example Image](../../../images/example-image.png)`
97+
Please place your image in `/src/assets/images`so that you can use it like this `[Example Image](/src/assets/images/example-image.png)` while using `yarn dev`. Before PR request add `https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main` before every image like this `[Example Image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/example-image.png)`
98+
:::
99+
:::caution
100+
To make ThemeImage work, add `import ThemeImage from '/src/components/ThemeImage.astro'` right after Frontmatter. If you forget to do this, `yarn dev` won't see any problems, but the site won't work, so do a `yarn build` before PR to check if everything is ok.
91101
:::
92102

93103
### 7. Add Your Page to the Sidebar Navigation (If Required)

src/content/docs/hardware/fpv-thinker-aio.md renamed to src/content/docs/hardware/OpenIPC/VTX/fpv-thinker-aio.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Two variants of the unit are available:
1212

1313
[^1]: RTL8731BU, typical peak TX power is 50mW @ 5G, 125mW @ 2.4G
1414

15-
![image: Thinker Air Unit Kit](/src/assets/images/aio-thinker/thinker-webshop-photo.jpg "Thinker Air Unit Kit")
15+
![image: Thinker Air Unit Kit](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/aio-thinker/thinker-webshop-photo.jpg "Thinker Air Unit Kit")
1616

1717
### Specifications
1818

@@ -94,7 +94,7 @@ For proper communication, ensure that D+ is connected to D+ and D- is connected
9494

9595
#### System Connectivity & Physical Specifications
9696

97-
![image: Thinker Connectivity & User-Accessible Components](/src/assets/images/aio-thinker/thinker-connectivity.png "Thinker Connectivity & User-Accessible Components")
97+
![image: Thinker Connectivity & User-Accessible Components](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/aio-thinker/thinker-connectivity.png "Thinker Connectivity & User-Accessible Components")
9898

9999
| Pin Name | Dir | Description |
100100
|-------------|------|----------------------------------------------------------------|
@@ -121,7 +121,7 @@ For proper communication, ensure that D+ is connected to D+ and D- is connected
121121
| RX | In | UART1 receive line |
122122
| TX | Out | UART1 transmit line |
123123

124-
![image: Thinker PCB And Heats Sink Dimensions](/src/assets/images/aio-thinker/thinker-dimensions.png "Thinker PCB And Heat Sink Dimensions")
124+
![image: Thinker PCB And Heats Sink Dimensions](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/aio-thinker/thinker-dimensions.png "Thinker PCB And Heat Sink Dimensions")
125125

126126
#### *Installation Tips and Precautions*
127127

@@ -176,7 +176,7 @@ There are several ways to update the firmware on your Thinker Air Unit, but the
176176

177177
The latest standard firmware can be downloaded [here](https://github.com/OpenIPC/builder/releases/download/latest/ssc338q_fpv_openipc-thinker-aio-nor.tgz). This version (`ssc338q_fpv_openipc-thinker-aio-nor`) includes drivers for **RTL8812AU** and **RTL873xBU** WiFi modules.
178178

179-
If you're using an **RTL8812EU** module, use [this alternate firmware](https://github.com/OpenIPC/builder/releases/download/latest/ssc338q_fpv_openipc-urllc-aio-nor.tgz) (`ssc338q_fpv_openipc-urllc-aio-nor`).
179+
If you're using an [**RTL8812EU**](/use-cases/fpv/net-cards/rtl8812eu) module, use [this alternate firmware](https://github.com/OpenIPC/builder/releases/download/latest/ssc338q_fpv_openipc-urllc-aio-nor.tgz) (`ssc338q_fpv_openipc-urllc-aio-nor`).
180180

181181
#### Advanced Configuration
182182

‎src/content/docs/hardware/Runcam/VTX/runcam-wifilink-v1.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Runcam WiFiLink V1 documentation page for OpenIPC wiki"
44
---
55
import ThemeImage from '/src/components/ThemeImage.astro'
66

7-
![image](/src/assets/images/runcam-wifilink-v1-main-photo.png)
7+
![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-main-photo.png)
88

99
### Specifications
1010

@@ -18,22 +18,22 @@ import ThemeImage from '/src/components/ThemeImage.astro'
1818
|Weight | 30g |
1919
|Antennas | IPEX connector |
2020
|PA | 29dBm (800 mW) |
21-
|WiFi chip | [BL-M8812EU2](/use-cases/fpv/wifi-adapters/rtl8812eu) (5MHz, 10MHz, 20MHz) |
21+
|WiFi chip | [BL-M8812EU2](/use-cases/fpv/net-cards/rtl8812eu) (5MHz, 10MHz, 20MHz) |
2222
|UARTs | 1 |
2323
|SOC | SigmaStar SSC338Q |
2424
| Firmware | ssc338q_fpv_openipc_urllc_aio_nor.tgz |
2525

2626
### Layout
2727
Motherboard up
2828
<ThemeImage
29-
lightSrc="/src/assets/images/runcam-wifilink-v1-motherboard-up-dark.png"
30-
darkSrc="/src/assets/images/runcam-wifilink-v1-motherboard-up-light.png"
29+
lightSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-up-dark.png"
30+
darkSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-up-light.png"
3131
alt="Motherboard up image"
3232
/>
3333
Motherboard down
3434
<ThemeImage
35-
lightSrc="/src/assets/images/runcam-wifilink-v1-motherboard-down.png"
36-
darkSrc="/src/assets/images/runcam-wifilink-v1-motherboard-down-dark.png"
35+
lightSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-down.png"
36+
darkSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v1-motherboard-down-dark.png"
3737
alt="Motherboard up image"
3838
/>
3939

@@ -56,7 +56,7 @@ For advanced setup guide please read this [article](/use-cases/fpv/advanced-setu
5656
digital VTX's(as on image below) or direct solder to UART on FC(you should connect power input to BEC output on FC). \
5757
**Attention:** the cable color codes will match only on one end.
5858
Double check your wiring (gnd to gnd, vcc to vcc, etc)
59-
![image](/src/assets/images/runcam-to-fc-connection.png)
59+
![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-to-fc-connection.png)
6060

6161
- Insert a formatted micro SD card into the Runcam. The slot is on the
6262
bottom of the unit, when the fan faces up.

‎src/content/docs/hardware/Runcam/VTX/runcam-wifilink-v2.mdx‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: "Runcam WiFiLink 2 documentation page for OpenIPC wiki"
44
---
55
import ThemeImage from '/src/components/ThemeImage.astro'
66

7-
![image](/src/assets/images/runcam-wifilink-v2-main-photo.png)
7+
![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v2-main-photo.png)
88

99
### Specifications
1010

@@ -18,21 +18,21 @@ import ThemeImage from '/src/components/ThemeImage.astro'
1818
|Weight | 30g(with fan) / 25g (without fan) |
1919
|Antennas | IPEX connector |
2020
|PA | 28dBm(FCC), 20dBm(CE) / 630mW(FCC), 100mW(CE) |
21-
|WiFi chip | [Runcam custom RTL8812EU](/use-cases/fpv/wifi-adapters/rtl8812eu) (5MHz, 10MHz, 20MHz) |
21+
|WiFi chip | [Runcam custom RTL8812EU](/use-cases/fpv/net-cards/rtl8812eu) (5MHz, 10MHz, 20MHz) |
2222
|UARTs | 1 |
2323
|SOC | SigmaStar SSC338Q |
2424
| Firmware | ssc338q_fpv_openipc_urllc_aio_nor.tgz |
2525

2626
### Layout
2727
<ThemeImage
28-
lightSrc="/src/assets/images/runcam-wifilink-2-motherboard-down-light.png"
29-
darkSrc="/src/assets/images/runcam-wifilink-2-motherboard-down-dark.png"
28+
lightSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-down-light.png"
29+
darkSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-down-dark.png"
3030
alt="Motherboard down image"
3131
/>
3232

3333
<ThemeImage
34-
lightSrc="/src/assets/images/runcam-wifilink-2-motherboard-up-light.png"
35-
darkSrc="/src/assets/images/runcam-wifilink-2-motherboard-up-dark.png"
34+
lightSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-up-light.png"
35+
darkSrc="https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-2-motherboard-up-dark.png"
3636
alt="Motherboard down image"
3737
/>
3838

@@ -55,7 +55,7 @@ For advanced setup guide please read this [article](/use-cases/fpv/advanced-setu
5555
digital VTX's(as on image below) or direct solder to UART on FC(you should connect power input to BEC output on FC). \
5656
**Attention:** the cable color codes will match only on one end.
5757
Double check your wiring (gnd to gnd, vcc to vcc, etc)
58-
![image](/src/assets/images/runcam-wifilink-v2-to-fc-connection.png)
58+
![image](https://raw.githubusercontent.com/OpenIPC/docs/refs/heads/main/src/assets/images/runcam-wifilink-v2-to-fc-connection.png)
5959

6060
- Insert a formatted micro SD card into the VTX. The slot is on the
6161
bottom of the unit, when the fan faces up.

‎src/content/docs/hardware/fpv-mario-aio.md‎

Lines changed: 0 additions & 228 deletions
This file was deleted.

0 commit comments

Comments
 (0)