Skip to content

Commit 2236922

Browse files
committed
更新文档中心FAQ
1 parent a80f151 commit 2236922

File tree

31 files changed

+128
-38
lines changed

31 files changed

+128
-38
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ $ sdk-bsp-psoc_e84-edgi-talk
2828
│ ├── Edgi-Talk_AHT20
2929
│ ├── Edgi-Talk_Audio
3030
│ ├── Edgi-Talk_Blink_Led
31+
│ ├── Edgi_Talk_CherryUSB
32+
│ │ ├── Edgi_Talk_M33_USB_D
33+
│ │ ├── Edgi_Talk_M33_USB_H
34+
│ │ ├── Edgi_Talk_M55_USB_D
35+
│ │ └── Edgi_Talk_M55_USB_H
3136
│ ├── Edgi-Talk_CoreMark
3237
│ ├── Edgi-Talk_CDC_Echo
3338
│ ├── Edgi-Talk_HyperRam

README_zh.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,29 @@ $ sdk-bsp-psoc_e84-edgi-talk
2424
├── libraries
2525
│ ├── HAL_Drivers
2626
├── projects
27-
│ ├── Edgi-Talk_ADC
28-
│ ├── Edgi-Talk_AHT20
29-
│ ├── Edgi-Talk_Audio
30-
│ ├── Edgi-Talk_Blink_Led
31-
│ ├── Edgi-Talk_CoreMark
32-
│ ├── Edgi-Talk_CDC_Echo
33-
│ ├── Edgi-Talk_HyperRam
34-
│ ├── Edgi-Talk_Key_Irq
35-
│ ├── Edgi-Talk_LSM6DS3
36-
│ ├── Edgi-Talk_LVGL
27+
│ ├── Edgi_Talk_ADC
28+
│ ├── Edgi_Talk_AHT20
29+
│ ├── Edgi_Talk_Audio
30+
│ ├── Edgi_Talk_Blink_Led
31+
│ ├── Edgi_Talk_CherryUSB
32+
│ │ ├── Edgi_Talk_M33_USB_D
33+
│ │ ├── Edgi_Talk_M33_USB_H
34+
│ │ ├── Edgi_Talk_M55_USB_D
35+
│ │ └── Edgi_Talk_M55_USB_H
36+
│ ├── Edgi_Talk_CoreMark
37+
│ ├── Edgi_Talk_CDC_Echo
38+
│ ├── Edgi_Talk_HyperRam
39+
│ ├── Edgi_Talk_Key_Irq
40+
│ ├── Edgi_Talk_LSM6DS3
41+
│ ├── Edgi_Talk_LVGL
3742
│ ├── Edgi_Talk_M33_Blink_LED
38-
│ ├── Edgi-Talk_M33_Template
39-
│ ├── Edgi-Talk_MIPI_LCD
40-
│ ├── Edgi-Talk_RTC
41-
│ ├── Edgi-Talk_SDCARD
42-
│ ├── Edgi-Talk_WavPlayer
43-
│ ├── Edgi-Talk_WIFI
44-
│ ├── Edgi-Talk_XiaoZhi
43+
│ ├── Edgi_Talk_M33_Template
44+
│ ├── Edgi_Talk_MIPI_LCD
45+
│ ├── Edgi_Talk_RTC
46+
│ ├── Edgi_Talk_SDCARD
47+
│ ├── Edgi_Talk_WavPlayer
48+
│ ├── Edgi_Talk_WIFI
49+
│ ├── Edgi_Talk_XiaoZhi
4550
└── rt-thread
4651
```
4752

docs/source/config.yaml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,21 @@ categories:
5353
- "Edgi_Talk_M55_LVGL"
5454
- "Edgi_Talk_M33_WavPlayer"
5555
- "Edgi_Talk_M55_XiaoZhi"
56+
usb:
57+
name: "USB篇"
58+
name_en: "USB"
59+
description: "USB主机和设备驱动"
60+
patterns:
61+
- "Edgi_Talk_CherryUSB/Edgi_Talk_M33_USB_D"
62+
- "Edgi_Talk_CherryUSB/Edgi_Talk_M33_USB_H"
63+
- "Edgi_Talk_CherryUSB/Edgi_Talk_M55_USB_D"
64+
- "Edgi_Talk_CherryUSB/Edgi_Talk_M55_USB_H"
65+
faq:
66+
name: "常见问题"
67+
name_en: "FAQ"
68+
description: "常见问题解答"
69+
patterns:
70+
- "FAQ_page"
5671
# 文档生成配置
5772
generation:
5873
copy_files:
@@ -65,7 +80,9 @@ generation:
6580
- "basic"
6681
- "driver"
6782
- "component"
83+
- "usb"
6884
- "protocol"
85+
- "faq"
6986

7087
# Sphinx 配置
7188
sphinx:

projects/Edgi_Talk_M33_ADC/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ The system boot sequence is as follows:
124124

125125
---
126126

127-
* If the example project does not run correctly, compile and flash the **Edgi-Talk_M33_S_Template** project first to ensure proper initialization and core startup sequence before running this example.
127+
* If the example project does not run correctly, compile and flash the **Edgi_Talk_M33_Blink_LED** project first to ensure proper initialization and core startup sequence before running this example.
128128
* To enable the M55 core, configure the **M33 project** as follows:
129129

130130
```

projects/Edgi_Talk_M33_AHT20/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ The system boot sequence is as follows:
112112

113113
---
114114

115-
* If the example project does not run correctly, compile and flash the **Edgi-Talk_M33_S_Template** project first to ensure proper initialization and core startup sequence before running this example.
115+
* If the example project does not run correctly, compile and flash the **Edgi_Talk_M33_Blink_LED** project first to ensure proper initialization and core startup sequence before running this example.
116116
* To enable the M55 core, configure the **M33 project** as follows:
117117

118118
```

projects/Edgi_Talk_M33_Audio/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ The system boot sequence is as follows:
120120

121121
---
122122

123-
* If the example project does not run correctly, compile and flash the **Edgi-Talk_M33_S_Template** project first to ensure proper initialization and core startup sequence before running this example.
123+
* If the example project does not run correctly, compile and flash the **Edgi_Talk_M33_Blink_LED** project first to ensure proper initialization and core startup sequence before running this example.
124124
* To enable the M55 core, configure the **M33 project** as follows:
125125

126126
```

projects/Edgi_Talk_M33_Blink_LED/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The system boot sequence is as follows:
104104

105105
---
106106

107-
* If the example project does not run correctly, compile and flash the **Edgi-Talk_M33_S_Template** project first to ensure proper initialization and core startup before running this example.
107+
* If the example project does not run correctly, compile and flash the **Edgi_Talk_M33_Blink_LED** project first to ensure proper initialization and core startup before running this example.
108108
* To enable the M55 core, configure the **M33 project** as follows:
109109

110110
```

projects/Edgi_Talk_M33_CDC_Echo/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The system starts in the following order:
121121

122122
---
123123

124-
* If the example does not run correctly, first compile and flash the **Edgi-Talk_M33_S_Template** project to ensure proper initialization and core startup, then run this example.
124+
* If the example does not run correctly, first compile and flash the **Edgi_Talk_M33_Blink_LED** project to ensure proper initialization and core startup, then run this example.
125125
* To enable the M55 core, enable the following configuration in the **M33 project**:
126126

127127
```

projects/Edgi_Talk_M33_HyperRam/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The system starts in the following order:
9292
9393
---
9494
95-
* If the example does not run correctly, first compile and flash the **Edgi-Talk_M33_S_Template** project to ensure proper initialization and core startup, then run this example.
95+
* If the example does not run correctly, first compile and flash the **Edgi_Talk_M33_Blink_LED** project to ensure proper initialization and core startup, then run this example.
9696
* To enable the M55 core, enable the following configuration in the **M33 project**:
9797
9898
```

projects/Edgi_Talk_M33_Key_Irq/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ The system starts in the following order:
121121

122122
---
123123

124-
* If the example does not run correctly, first compile and flash the **Edgi-Talk_M33_S_Template** project to ensure proper initialization and core startup, then run this example.
124+
* If the example does not run correctly, first compile and flash the **Edgi_Talk_M33_Blink_LED** project to ensure proper initialization and core startup, then run this example.
125125
* To enable the M55 core, enable the following configuration in the **M33 project**:
126126

127127
```

0 commit comments

Comments
 (0)