跳到主要内容

社区资源

社区成员常用的入口材料集中在这里,包括官方文档、社区贡献内容、相关项目以及推荐的阅读顺序。技术实现细节由主文档站承载,遇到具体问题时以那里的说明为准。

1. 官方文档​

官方文档按主题组织,覆盖从入门到深入实现的各个层次。查找资料时,先确定问题属于使用方式还是实现原理,再进入对应章节,通常比逐页翻阅更快。

1.1 文档导航​

下表列出社区成员最常使用的文档入口及其覆盖范围,可以帮助快速定位所需内容,更完整的目录结构可以在文档站侧边栏中查看,其中按主题顺序列出了全部章节。

文档覆盖范围
项目概览工作区定位与各系统路径的分工
快速开始环境准备与首次运行
总体架构各子系统的设计原理
构建系统构建、运行与部署方式
测试与验证测试策略与持续集成
调试方法问题的定位与分析方法

想了解怎么用,看快速开始与构建相关的章节;想了解为什么这样设计,看架构章节;遇到异常或在运行中卡住,则从调试章节入手。三类问题在文档中各有归属,按这个顺序查找通常比逐页翻阅更快。

1.2 上手入口​

快速开始按系统分别列出环境准备、构建命令和首次运行方式,是上手时的最短路径。三篇内容相互独立,可以只阅读自己关注的那一部分,不必按顺序读完。

文档站与博客也提供其他语言的说明和阶段性总结,适合在熟悉基本流程后了解社区近期的方向,具体入口以站点导航为准,也可以直接检索文章标题中的关键词。

2. 社区资源​

社区成员贡献的工具、教程和示例是官方文档的补充,其中不少内容来自实际移植和调试过程,记录了文档尚未覆盖的细节。提交这类材料时,说明用途和适用范围可以让使用者更容易判断是否适合自己的场景。

2.1 工具与集成​

辅助构建、运行和排查问题的脚本,对第三方工具或框架的适配,以及测试环境相关的集成都属于这一类,共同点是能让日常操作少一些重复劳动。

建议在提交时说明工具的用途、适用范围和维护方式,并注明依赖的外部程序,便于他人长期使用而不必先读懂实现,也方便后续有人接手维护。

2.2 教程与经验文章​

逐步讲解某个子系统实现原理的文章、记录一次完整移植或调试过程的实践笔记,以及性能分析与问题定位的方法都属于这一类。这类内容通常是官方文档之外最有价值的补充,因为它们记录了真实的排查过程和当时的判断依据。

写作格式与站点组织方式见文档部署,提交前请确认引用的链接有效,并说明内容对应的版本或系统状态,避免读者按过期的描述操作。

2.3 示例与实践​

可运行的示例、配置示例和测试用例模板都属于这一类。示例应当可以直接运行,并说明所依赖的环境和预期结果;如果示例只在特定条件下可用,请一并写明限制。

希望分享仓库之外的资源时,可以在社区讨论中介绍其用途和适用范围,由维护者判断是否适合收录到文档中,长期无人维护的内容通常不单独列出。

3. 相关项目​

TGOSKits 与上下游的开源项目保持同步,社区成员也参与这些项目的维护,因此一个问题的修复往往需要先在上游完成,再随同步进入工作区。

3.1 上游项目​

工作区中的系统路径来自对应的上游仓库,改动会先在上游完成,再同步回工作区。这种组织方式让各系统可以独立演进,也让关注单一系统的参与者不必了解整个工作区。

项目说明
TGOSKits社区维护的统一工作区
ArceOS组件化内核
StarryOSLinux 兼容操作系统
Axvisor基于 ArceOS 的虚拟机监控器

组件与上游仓库的对应关系及同步方式见仓库管理指南。如果改动只影响工作区自身的组织方式,则直接在主仓库中提交,不必先修改上游。

3.2 社区与生态​

rcore-os 组织下有多个相关仓库,覆盖操作系统、虚拟化和教学资源等方向。社区成员也可以参与这些项目的讨论与维护,工作区中的经验往往可以直接应用过去。

希望在 TGOSKits 之上开展合作或定制工作的团队,可以通过团队成员页面列出的渠道联系,说明使用场景和期望的产出形式。

4. 学习路径​

系统软件涉及的知识面较广,各个子系统之间又相互依赖,按照合适的顺序阅读可以减少来回查找的成本,也能更早建立起对系统整体行为的判断。

4.1 推荐顺序​

先跑通一次完整的构建与运行,再回头理解实现,比只看代码更容易建立对系统整体行为的判断,因为运行结果会直接说明各部分的职责边界。

  1. 按快速开始完成一次目标系统的构建与运行
  2. 阅读关于我们与仓库管理指南,了解社区的组织方式与协作约定
  3. 对照总体架构阅读感兴趣的子系统
  4. 按贡献指南准备第一次提交

4.2 实践建议​

在环境中验证过的结论比静态阅读更可靠,因为很多行为取决于具体的配置和目标平台。遇到与文档描述不一致的情况,欢迎提交议题反馈,说明使用的环境和复现步骤,这对社区同样有价值。

5. 资源收录​

收录范围限于可公开访问且与社区维护相关的内容,需要额外账号或指向私有仓库的资源不便长期维护,也难以为其他参与者验证,因此统一放在社区讨论中介绍。

5.1 收录标准​

资源应能被其他参与者直接使用:文档和工具可以获取,示例可以运行,引用他人材料时注明出处。已经停止维护的资源会从页面中移除,避免后来者被过期信息误导。

5.2 提交方式​

先在社区讨论中介绍资源的用途和适用范围,再提交拉取请求把它补充到对应的小节。提交时请说明内容与 TGOSKits 的关系,便于维护者判断归属,也便于后续更新时找到合适的负责人。