79f839bbf0
把这轮媒体治理沉淀成规范，核心是一张体积上限表： 静态图 300KB/500KB · SVG 500KB/1MB 3 秒内动图 WebP 500KB/1MB（严禁 GIF，超 5 秒别用 WebP） 5 秒以上动图 MP4 1MB/2MB，等效 1080p 1Mbps（录屏类 0.5Mbps） 画质对比样片放宽到 4MB；再大的传 B 站/YouTube 内嵌，不进仓库 新增三节： - MP4 按「等效 1080p 码率」衡量而不是只看文件大小。实测一个 2.2MB 的小动图折合 1080p 高达 39.6Mbps，按 1Mbps 重编后 57KB；反过来 7.7MB 的长录屏折合才 1098k，压它只会糊。先看帧率再调码率， 120fps 降 30fps 直接省 3/4。 - 不要重复存放同一张图：没有中英差异的只放中文目录一份。清理历史 重复要同时满足「文件名相同」和「不含同族两个型号」，后者防止把 lpi3a/lpi4a 这类独立产品线绑在一起。 - 批量处理素材的纪律：基线对比、以构建产物为准、保留 CRLF 行尾、 替换带定界符、通用文件名不自动匹配、删引用要删整个标记。 自检清单与坑速查表同步更新。
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.