b127ebeb82
人工逐条确认后处置 39 项： - delete 33 处：素材在整个仓库都不存在（从未提交或连同目录被删）， 删掉整个图片标记而非只删路径，markdown ![]() 与 <img src> 两种 写法都处理；表格内只清空单元格、保留表格结构；删后遗留的空 <center class=half></center> 等空壳标记一并清理 - use 1 处：uboot_conf_9.gif -> uboot_conf_9.jpg（扩展名写错） - todo 4 处：保留引用等工程师补图，见下 - skip 1 处：pages/index/zh/threshold.html 的 demo_color.jpg 读写文件保留原始行尾——这批文件多为 CRLF，用默认模式会把整个文件 转成 LF，改动量会从 42 行虚增到 1200 多行。 待补素材（3 张，补进来后基线可再缩减）： docs/hardware/assets/NanoKVM/guide/atx_2024.png docs/hardware/assets/NanoKVM/pro/ledstrip/ledstrip_show.png docs/hardware/en/logic_analyzer/slogic16u3/assets/Screenshots/SLogic_Connect_1.png 断链 39 -> 5。
Sipeed wiki source docs
Sipeed official Wiki: wiki.sipeed.com
Contributing and article sharing
You are welcome to contribute to the wiki, fixing error, adding content, or sharing your article are all welcome.
Fork this repo and change docs, then create a Pull Request.
More contribute doc :
Preview locally
git clone --depth=1 https://github.com/sipeed/sipeed_wiki.git
cd sipeed_wiki
uv sync
uv run teedoc serve
uv sync creates/updates the .venv from pyproject.toml and uv.lock, which already includes teedoc and all plugins used by this site (so teedoc install is not needed).
Install uv first if you don't have it.
Why --depth=1
This is a documentation site, so most of the repo is images. Git keeps every past revision of every one of them forever, including large originals that have since been replaced by compressed versions. A full clone therefore downloads roughly 1 GB of history even though you only ever need the current version of each file.
--depth=1 fetches just the latest commit and skips all of that. Editing docs and opening
a pull request works exactly the same from a shallow clone. Use a full clone only when you
actually need the history (git log, git blame, git bisect) — you can always deepen a
shallow clone later with git fetch --unshallow.
When adding images, please keep them small (ideally under 300 KB, 500 KB max): anything committed here stays in the history for good, so an oversized image costs every future contributor bandwidth even after it is deleted. See AGENTS.md for the full image and authoring guidelines.
More build tool usage see teedoc
For administrator
GitHub action will automatically push changed doc to cloud server. But if you did some special things like force commit, some files maybe missing on server, manually trigger the publish_upload_all action to build doc and upload all files to server.