场景化示例

这些示例不是孤立的“功能演示”,而是可直接映射到真实仓库的文档方案。每个场景都明确内容结构、配置选择、构建命令和可观察的交付结果。

场景

适合什么团队

重点验证

嵌入式 SDK 开发手册

维护安装、接口和调试文档的 SDK 团队

递归文档树、双语、丰富 Markdown

BSP 与驱动目录

包含多个板级包和示例工程的团队

严格项目目录、分类和资源白名单

可归档的 PDF 发布手册

需要交付给客户、现场或审核方的团队

XeLaTeX、字体、版式、书签与图片

多版本 GitHub Pages

同时维护 latest 与稳定版本的开源项目

worktree、Artifact、PR 校验和 Pages

每个页面都可以成为项目 README 的链接目标,向潜在贡献者展示模板不是“安装后待填空的脚手架”,而是已考虑真实发布链路的工程基础设施。