Browse Source

doc: add more chapters to the manual

Signed-off-by: Zhouqi Jiang <luojia@hust.edu.cn>
Zhouqi Jiang 2 months ago
parent
commit
86530ec354
43 changed files with 73 additions and 13 deletions
  1. 1 0
      docs/src/03_prototyper/01_introduction.md
  2. 1 0
      docs/src/03_prototyper/02_configuration.md
  3. 1 0
      docs/src/03_prototyper/03_debugging.md
  4. 1 0
      docs/src/03_prototyper/04_error_code.md
  5. 1 1
      docs/src/04_hal/allwinner.md
  6. 1 0
      docs/src/05_platform/milkv_duo.md
  7. 1 0
      docs/src/05_platform/qemu_virt.md
  8. 1 0
      docs/src/05_platform/sipeed_m1s_dock.md
  9. 1 0
      docs/src/06_os/arceos.md
  10. 1 0
      docs/src/06_os/arch_linux.md
  11. 1 0
      docs/src/06_os/asterinas.md
  12. 1 0
      docs/src/06_os/dragonos.md
  13. 1 0
      docs/src/06_os/fedora.md
  14. 1 0
      docs/src/06_os/freebsd.md
  15. 1 0
      docs/src/06_os/linux_kernel.md
  16. 1 0
      docs/src/06_os/openeuler.md
  17. 1 0
      docs/src/06_os/openwrt.md
  18. 1 0
      docs/src/06_os/polyos.md
  19. 1 0
      docs/src/06_os/rcore.md
  20. 1 0
      docs/src/06_os/rustsbi_test_kernel.md
  21. 1 0
      docs/src/06_os/ubuntu.md
  22. 1 0
      docs/src/07_development/emulator.md
  23. 1 0
      docs/src/07_development/new-platform-prototyper.md
  24. 1 0
      docs/src/07_development/sbi-kernel.md
  25. 1 0
      docs/src/07_development/vmm.md
  26. 0 0
      docs/src/08_incubating/arceboot.md
  27. 0 0
      docs/src/08_incubating/rustsbi_agent.md
  28. 1 0
      docs/src/09_ecosystem/oreboot.md
  29. 1 0
      docs/src/09_ecosystem/zsbl.md
  30. 0 0
      docs/src/10_oss_guide/01_usage.md
  31. 0 0
      docs/src/10_oss_guide/02_contribution.md
  32. 0 0
      docs/src/10_oss_guide/03_development.md
  33. 0 0
      docs/src/10_oss_guide/04_community.md
  34. 40 10
      docs/src/SUMMARY.md
  35. 0 1
      docs/src/chapter_05.md
  36. 1 0
      docs/src/chapter_05_platform.md
  37. 1 0
      docs/src/chapter_06_os.md
  38. 1 0
      docs/src/chapter_07_development.md
  39. 0 1
      docs/src/chapter_07_oss_guide.md
  40. 0 0
      docs/src/chapter_08_incubating.md
  41. 1 0
      docs/src/chapter_09_ecosystem.md
  42. 1 0
      docs/src/chapter_10_oss_guide.md
  43. 1 0
      docs/src/references.md

+ 1 - 0
docs/src/03_prototyper/01_introduction.md

@@ -0,0 +1 @@
+# 简介、应用场景与生态软件适配

+ 1 - 0
docs/src/03_prototyper/02_configuration.md

@@ -0,0 +1 @@
+# 编译与配置

+ 1 - 0
docs/src/03_prototyper/03_debugging.md

@@ -0,0 +1 @@
+# 调试 RustSBI Prototyper

+ 1 - 0
docs/src/03_prototyper/04_error_code.md

@@ -0,0 +1 @@
+# 常见故障与错误码速查表

+ 1 - 1
docs/src/04_hal/allwinner.md

@@ -1 +1 @@
-# allwnner-hal 全志芯片支持包
+# allwinner-hal 全志芯片支持包

+ 1 - 0
docs/src/05_platform/milkv_duo.md

@@ -0,0 +1 @@
+# Milk-V Duo 开发板

+ 1 - 0
docs/src/05_platform/qemu_virt.md

@@ -0,0 +1 @@
+# QEMU virt 模拟器平台

+ 1 - 0
docs/src/05_platform/sipeed_m1s_dock.md

@@ -0,0 +1 @@
+# Sipeed M1s Dock 开发板

+ 1 - 0
docs/src/06_os/arceos.md

@@ -0,0 +1 @@
+# ArceOS 操作系统

+ 1 - 0
docs/src/06_os/arch_linux.md

@@ -0,0 +1 @@
+# Arch Linux 操作系统

+ 1 - 0
docs/src/06_os/asterinas.md

@@ -0,0 +1 @@
+# Asterinas 操作系统

+ 1 - 0
docs/src/06_os/dragonos.md

@@ -0,0 +1 @@
+# DragonOS 操作系统

+ 1 - 0
docs/src/06_os/fedora.md

@@ -0,0 +1 @@
+# Fedora 操作系统

+ 1 - 0
docs/src/06_os/freebsd.md

@@ -0,0 +1 @@
+# FreeBSD 操作系统

+ 1 - 0
docs/src/06_os/linux_kernel.md

@@ -0,0 +1 @@
+# Linux 内核(不基于发行版)

+ 1 - 0
docs/src/06_os/openeuler.md

@@ -0,0 +1 @@
+# openEuler 操作系统

+ 1 - 0
docs/src/06_os/openwrt.md

@@ -0,0 +1 @@
+# OpenWrt 操作系统

+ 1 - 0
docs/src/06_os/polyos.md

@@ -0,0 +1 @@
+# PolyOS 操作系统

+ 1 - 0
docs/src/06_os/rcore.md

@@ -0,0 +1 @@
+# rCore 操作系统

+ 1 - 0
docs/src/06_os/rustsbi_test_kernel.md

@@ -0,0 +1 @@
+# RustSBI 测试用内核

+ 1 - 0
docs/src/06_os/ubuntu.md

@@ -0,0 +1 @@
+# Ubuntu 操作系统

+ 1 - 0
docs/src/07_development/emulator.md

@@ -0,0 +1 @@
+# 提供 SBI 服务的指令集模拟器

+ 1 - 0
docs/src/07_development/new-platform-prototyper.md

@@ -0,0 +1 @@
+# 为 Prototyper 适配新的裸机平台

+ 1 - 0
docs/src/07_development/sbi-kernel.md

@@ -0,0 +1 @@
+# 开发基于 SBI 的系统内核

+ 1 - 0
docs/src/07_development/vmm.md

@@ -0,0 +1 @@
+# RISC-V H 扩展虚拟化宿主系统

+ 0 - 0
docs/src/06_incubating/arceboot.md → docs/src/08_incubating/arceboot.md


+ 0 - 0
docs/src/06_incubating/rustsbi_agent.md → docs/src/08_incubating/rustsbi_agent.md


+ 1 - 0
docs/src/09_ecosystem/oreboot.md

@@ -0,0 +1 @@
+# Oreboot LinuxBoot 引导解决方案

+ 1 - 0
docs/src/09_ecosystem/zsbl.md

@@ -0,0 +1 @@
+# 零阶段引导程序

+ 0 - 0
docs/src/07_oss_guide/01_usage.md → docs/src/10_oss_guide/01_usage.md


+ 0 - 0
docs/src/07_oss_guide/02_contribution.md → docs/src/10_oss_guide/02_contribution.md


+ 0 - 0
docs/src/07_oss_guide/03_development.md → docs/src/10_oss_guide/03_development.md


+ 0 - 0
docs/src/07_oss_guide/04_community.md → docs/src/10_oss_guide/04_community.md


+ 40 - 10
docs/src/SUMMARY.md

@@ -7,20 +7,50 @@
     - [`sbi-spec` 常量与常数库](./02_libraries/03_sbi_spec.md)
     - [`sbi-testing` 测试环境库](./02_libraries/04_sbi_testing.md)
 - [RustSBI Prototyper](./chapter_03_prototyper.md)
+    - [简介、应用场景与生态软件适配](./03_prototyper/01_introduction.md)
+    - [编译与配置](./03_prototyper/02_configuration.md)
+    - [调试 RustSBI Prototyper](./03_prototyper/03_debugging.md)
+    - [常见故障与错误码速查表](./03_prototyper/04_error_code.md)
 - [RustSBI 维护的裸机支持包](./chapter_04_hal.md)
-    - [`allwnner-hal` 全志芯片支持包](./04_hal/allwinner.md)
+    - [`allwinner-hal` 全志芯片支持包](./04_hal/allwinner.md)
     - [`bouffalo-hal` 博流芯片支持包](./04_hal/bouffalo.md)
     - [`hpmicro-hal` 先楫芯片支持包](./04_hal/hpmicro.md)
     - [`kendryte-hal` 勘智芯片支持包](./04_hal/kendryte.md)
     - [`sophgo-hal` 算能芯片支持包](./04_hal/sophgo.md)
     - [其它 RustSBI 贡献的支持包](./04_hal/others.md)
-- [实战案例](./chapter_05.md)
-- [孵化中的 RustSBI 项目](./chapter_06_incubating.md)
-    - [RustSBI Agent 大模型问答智能体](./06_incubating/rustsbi_agent.md)
-    - [ArceBoot 特权态引导程序](./06_incubating/arceboot.md)
-- [开源代码指南](./chapter_07_oss_guide.md)
-    - [代码获取与构建](./07_oss_guide/01_usage.md)
-    - [贡献流程规范](./07_oss_guide/02_contribution.md)
-    - [开发规范](./07_oss_guide/03_development.md)
-    - [社区资源](./07_oss_guide/04_community.md)
+- [平台用户指南](./chapter_05_platform.md)
+    - [QEMU virt 模拟器平台](./05_platform/qemu_virt.md)
+    - [Sipeed M1s Dock 开发板](./05_platform/sipeed_m1s_dock.md)
+    - [Milk-V Duo 开发板](./05_platform/milkv_duo.md)
+- [系统内核与发行版用户指南](./chapter_06_os.md)
+    - [Linux 内核(不基于发行版)](./06_os/linux_kernel.md)
+    - [Arch Linux 操作系统](./06_os/arch_linux.md)
+    - [Fedora 操作系统](./06_os/fedora.md)
+    - [FreeBSD 操作系统](./06_os/freebsd.md)
+    - [openEuler 操作系统](./06_os/openeuler.md)
+    - [OpenWrt 操作系统](./06_os/openwrt.md)
+    - [PolyOS 操作系统](./06_os/polyos.md)
+    - [Ubuntu 操作系统](./06_os/ubuntu.md)
+    - [ArceOS 操作系统](./06_os/arceos.md)
+    - [DragonOS 操作系统](./06_os/dragonos.md)
+    - [Asterinas 操作系统](./06_os/asterinas.md)
+    - [rCore 操作系统](./06_os/rcore.md)
+    - [RustSBI 测试用内核](./06_os/rustsbi_test_kernel.md)
+- [RustSBI 开发实战](./chapter_07_development.md)
+    - [开发基于 SBI 的系统内核](./07_development/sbi-kernel.md)
+    - [RISC-V H 扩展虚拟化宿主系统](./07_development/vmm.md)
+    - [提供 SBI 服务的指令集模拟器](./07_development/emulator.md)
+    - [为 Prototyper 适配新的裸机平台](./07_development/new-platform-prototyper.md)
+- [孵化中的 RustSBI 项目](./chapter_08_incubating.md)
+    - [RustSBI Agent 大模型问答智能体](./08_incubating/rustsbi_agent.md)
+    - [ArceBoot 特权态引导程序](./08_incubating/arceboot.md)
+- [引导生态简介](./chapter_09_ecosystem.md)
+    - [Oreboot LinuxBoot 引导解决方案](./09_ecosystem/oreboot.md)
+    - [零阶段引导程序](./09_ecosystem/zsbl.md)
+- [开放源代码指南](./chapter_10_oss_guide.md)
+    - [代码获取与构建](./10_oss_guide/01_usage.md)
+    - [贡献流程规范](./10_oss_guide/02_contribution.md)
+    - [开发规范](./10_oss_guide/03_development.md)
+    - [社区资源](./10_oss_guide/04_community.md)
+- [参考文献](./references.md)
 - [附录](./appendix.md)

+ 0 - 1
docs/src/chapter_05.md

@@ -1 +0,0 @@
-# 实战案例

+ 1 - 0
docs/src/chapter_05_platform.md

@@ -0,0 +1 @@
+# 平台用户指南

+ 1 - 0
docs/src/chapter_06_os.md

@@ -0,0 +1 @@
+# 系统内核与发行版用户指南

+ 1 - 0
docs/src/chapter_07_development.md

@@ -0,0 +1 @@
+# RustSBI 开发实战

+ 0 - 1
docs/src/chapter_07_oss_guide.md

@@ -1 +0,0 @@
-# 开源代码指南

+ 0 - 0
docs/src/chapter_06_incubating.md → docs/src/chapter_08_incubating.md


+ 1 - 0
docs/src/chapter_09_ecosystem.md

@@ -0,0 +1 @@
+# 引导生态简介

+ 1 - 0
docs/src/chapter_10_oss_guide.md

@@ -0,0 +1 @@
+# 开放源代码指南

+ 1 - 0
docs/src/references.md

@@ -0,0 +1 @@
+# 参考文献