docs(docs): 对文档内容进行新添和删改 #71
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reviewer's GuideThis PR overhauls the documentation by adding two new object detection tutorials for YOLOv5 and YOLOX under the NPU section, removing redundant typical-application pages, and comprehensively refactoring the installation guides for Lichee Pi 4A (Linux and Windows) and Milk-V Meles. It also refines the NPU environment setup guide and updates index and issue pages to standardize formatting, add clear warnings/notes, and improve overall coherence. Class diagram for documentation structure after refactorclassDiagram
class InstallationGuide {
+sidebar_position
+title
+description
+sections: Preparation, SD Card, eMMC, Troubleshooting
}
class ObjectDetectionTutorial {
+title
+description
+sections: ExampleCode, ModelAcquisition, Conversion, Compilation, Execution, Results
}
class NPUEnvironmentSetup {
+title
+description
+sections: BoardSetup, SHLInstall, HHBInstall, DriverConfig
}
class IndexPage {
+title
+description
+table: SupportedDevices, DownloadLinks, GuideLinks
}
class LicheePi4A_Linux
class LicheePi4A_Windows
class MilkVMeles
class YOLOv5
class YOLOX
class LicheePi4A_NPU
class InstallationIntro
class MainIntro
class IssuePage
InstallationGuide <|-- LicheePi4A_Linux
InstallationGuide <|-- LicheePi4A_Windows
InstallationGuide <|-- MilkVMeles
ObjectDetectionTutorial <|-- YOLOv5
ObjectDetectionTutorial <|-- YOLOX
NPUEnvironmentSetup <|-- LicheePi4A_NPU
IndexPage <|-- InstallationIntro
IndexPage <|-- MainIntro
IndexPage <|-- IssuePage
Flow diagram for NPU environment setup and model deploymentflowchart TD
A["Start: User wants to run object detection on Lichee Pi 4A"]
B["Complete NPU environment setup"]
C["Install SHL library and dependencies"]
D["Clone example code (YOLOv5/YOLOX)"]
E["Download/export ONNX model"]
F["Convert model with HHB (CPU/NPU)"]
G["Compile post-processing code (if needed)"]
H["Transfer files to device"]
I["Run inference and view results"]
A --> B --> C --> D --> E --> F --> G --> H --> I
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey there - I've reviewed your changes - here's some feedback:
- This PR is very large and touches many docs—consider splitting it into smaller, focused changes (e.g., core install guide updates vs. new model tutorials) to simplify review.
- Please verify and update all cross‐document links and sidebar/navigation entries so the newly added YOLOv5 and YOLOX pages are discoverable and no broken references remain.
- I noticed varying terminology in headings (e.g., “Installation Guide” vs “Flashing Guide”)—a quick consistency pass on key terms across all docs would improve cohesion.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- This PR is very large and touches many docs—consider splitting it into smaller, focused changes (e.g., core install guide updates vs. new model tutorials) to simplify review.
- Please verify and update all cross‐document links and sidebar/navigation entries so the newly added YOLOv5 and YOLOX pages are discoverable and no broken references remain.
- I noticed varying terminology in headings (e.g., “Installation Guide” vs “Flashing Guide”)—a quick consistency pass on key terms across all docs would improve cohesion.
## Individual Comments
### Comment 1
<location> `i18n/en/docusaurus-plugin-content-docs/current/Installation/licheepi4a.mdx:298-301` </location>
<code_context>
+If no version info is printed, install `fastboot`:
```bash
sudo apt install fastboot
```
-
-
-```bash
-sudo apt install fastboot
-```
-
-#### Install Serial Console Tool
+
-When using a serial connection, a serial console tool is required for monitoring. There are many serial console tools available, such as `minicom`, `screen`, and `picocom`. In this guide, we will use `minicom` for demonstration.
</code_context>
<issue_to_address>
**nitpick:** The fastboot installation screenshot is reused from zstd installation.
Please verify that `/img/image-for-flash/fastboot-install.png` accurately depicts the fastboot installation process.
</issue_to_address>
### Comment 2
<location> `i18n/en/docusaurus-plugin-content-docs/current/Installation/licheepi4a.mdx:345-347` </location>
<code_context>
-sudo wget u-boot-with-spl-lpi4a-16g-main.bin
-sudo wget boot-lpi4a-20250110_151339.ext4.zst
-sudo wget root-lpi4a-20250110_151339.ext4.zst
+sudo wget https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20250110/u-boot-with-spl-lpi4a-16g-main.bin
+sudo wget https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20250110/boot-lpi4a-20250110_151339.ext4.zst
+sudo wget https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20250110/root-lpi4a-20250110_151339.ext4.zst
</code_context>
<issue_to_address>
**suggestion:** The use of `sudo wget` may be unnecessary for downloading files.
Using `sudo` with `wget` can result in downloaded files being owned by root. Remove `sudo` unless elevated permissions are required for the destination directory.
```suggestion
wget https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20250110/u-boot-with-spl-lpi4a-16g-main.bin
wget https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20250110/boot-lpi4a-20250110_151339.ext4.zst
wget https://mirror.iscas.ac.cn/revyos/extra/images/lpi4a/20250110/root-lpi4a-20250110_151339.ext4.zst
```
</issue_to_address>
### Comment 3
<location> `i18n/en/docusaurus-plugin-content-docs/current/Installation/milkv-meles.mdx:180-185` </location>
<code_context>
-```bash
-wget https://fast-mirror.isrc.ac.cn/revyos/extra/images/meles/20250323/sdcard-meles-20250323_154525.img.zst
-```
+- [RevyOS 20240720 (Kernel 5.10)](https://mirror.iscas.ac.cn/revyos/extra/images/meles/20240720/)
+- Latest release (Kernel 6.6): {<DownloadLink device="Milk-V Meles" />}
-This file is a .zst compressed package, which needs to be decompressed after downloading. You can use the zstd tool to decompress it.
</code_context>
<issue_to_address>
**suggestion:** The download links for images do not specify which file to choose.
Please indicate the specific filename users should download, such as those starting with `sdcard-`, to avoid confusion.
```suggestion
To install RevyOS, download the SD card image file for your device.
**Choose the file whose name starts with `sdcard-meles-` from the following links:**
- [RevyOS 20240720 (Kernel 5.10)](https://mirror.iscas.ac.cn/revyos/extra/images/meles/20240720/) (look for files named `sdcard-meles-*.img.zst`)
- Latest release (Kernel 6.6): {<DownloadLink device="Milk-V Meles" />} (select the `sdcard-meles-*.img.zst` file)
```
</issue_to_address>
### Comment 4
<location> `i18n/en/docusaurus-plugin-content-docs/current/Installation/intro.mdx:30` </location>
<code_context>
-
+| Supported Device | Image Download (Latest Version) | Flashing Guide |
+| ------------------ | ------------------------------- | -------------- |
+| Lichee Pi 4A | {<DownloadLink device="Lichee Pi 4A" />} | {<RedirectBasedOnUA windowsLink="../licheepi4a-windows/" otherLink="../licheepi4a/" description="Flashing Guide" /> } |
+| Milk-V Meles | {<DownloadLink device="Milk-V Meles" />} | [Milk-V official flashing guide](https://milkv.io/zh/docs/meles/installation) |
+| Milk-V Pioneer | {<DownloadLink device="Milk-V Pioneer" />} | [Flashing Guide](../milkv-pioneer/) |
</code_context>
<issue_to_address>
**suggestion:** The table mixes English and Chinese guide links for Milk-V Meles.
Please add an English-language guide for Milk-V Meles or indicate in the table that the current guide is in Chinese.
```suggestion
| Milk-V Meles | {<DownloadLink device="Milk-V Meles" />} | [Milk-V official flashing guide (Chinese)](https://milkv.io/zh/docs/meles/installation) <br /> English guide coming soon |
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
i18n/en/docusaurus-plugin-content-docs/current/Installation/licheepi4a.mdx
Show resolved
Hide resolved
i18n/en/docusaurus-plugin-content-docs/current/Installation/licheepi4a.mdx
Show resolved
Hide resolved
i18n/en/docusaurus-plugin-content-docs/current/Installation/milkv-meles.mdx
Show resolved
Hide resolved
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
新添加两个目标识别模型，删除了典型应用中关于npu模型的重复部分，修正部分英文文档
Signed-off-by: LeeJc02 [email protected]
Summary by Sourcery
Overhaul and standardize the documentation: reorganize and internationalize installation guides, eliminate redundant pages, and introduce new step-by-step tutorials for YOLOv5 and YOLOX model deployment on the board’s NPU.
New Features:
Enhancements:
Documentation: