3cb995f851
早期文档的素材基本是中英共用一套，却在 docs/.../zh/ 和 docs/.../en/ 各存了一份完全相同的文件。251 组镜像副本，白占 39.5MB。 只处理「路径仅差语言段」的镜像组：保留 zh 作为规范副本，删除 en 副本， 把 en 页面的引用改向 zh（32U3 已经是这个约定）。引用改写基于解析后的 目标文件而非字符串匹配，共 39 个页面 214 处；文件读写保留原始行尾。 跨产品的重复没有动——tang-primer-20k 与 25k、lc3a 与 lc4a 虽然碰巧 共用同一张图，但文件名本就不同，合并会制造耦合：以后更新一个产品的 图会让另一个产品的文档悄悄跟着变。为省空间绑定两条独立产品线不划算。 验证：断链 5 -> 5（新增 0），构建通过，抽查英文页图片全部可取到。
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.