Ver código fonte

doc: add contents of the RustSBI Manual

Signed-off-by: Zhouqi Jiang <luojia@hust.edu.cn>
Zhouqi Jiang 2 meses atrás
pai
commit
ae05eeef14

+ 1 - 0
docs/.gitignore

@@ -0,0 +1 @@
+book

+ 6 - 0
docs/book.toml

@@ -0,0 +1,6 @@
+[book]
+authors = ["The RustSBI Community"]
+language = "zh"
+multilingual = false
+src = "src"
+title = "The RustSBI Manual"

+ 1 - 0
docs/src/02_libraries/01_rustsbi.md

@@ -0,0 +1 @@
+# rustsbi 核心抽象库

+ 1 - 0
docs/src/02_libraries/02_sbi_rt.md

@@ -0,0 +1 @@
+# sbi-rt 特权态运行环境

+ 1 - 0
docs/src/02_libraries/03_sbi_spec.md

@@ -0,0 +1 @@
+# sbi-spec 常量与常数库

+ 1 - 0
docs/src/02_libraries/04_sbi_testing.md

@@ -0,0 +1 @@
+# sbi-testing 测试环境库

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

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

+ 1 - 0
docs/src/04_hal/bouffalo.md

@@ -0,0 +1 @@
+# bouffalo-hal 博流芯片支持包

+ 1 - 0
docs/src/04_hal/hpmicro.md

@@ -0,0 +1 @@
+# hpmicro-hal 先楫芯片支持包

+ 1 - 0
docs/src/04_hal/kendryte.md

@@ -0,0 +1 @@
+# kendryte-hal 勘智芯片支持包

+ 1 - 0
docs/src/04_hal/others.md

@@ -0,0 +1 @@
+# 其它 RustSBI 贡献的支持包

+ 1 - 0
docs/src/04_hal/sophgo.md

@@ -0,0 +1 @@
+# sophgo-hal 算能芯片支持包

+ 1 - 0
docs/src/06_incubating/arceboot.md

@@ -0,0 +1 @@
+# ArceBoot 特权态引导程序

+ 1 - 0
docs/src/06_incubating/rustsbi_agent.md

@@ -0,0 +1 @@
+# RustSBI Agent 大模型问答智能体

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

@@ -0,0 +1 @@
+# 代码获取与构建

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

@@ -0,0 +1 @@
+# 贡献流程规范

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

@@ -0,0 +1 @@
+# 开发规范

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

@@ -0,0 +1 @@
+# 社区资源

+ 26 - 0
docs/src/SUMMARY.md

@@ -0,0 +1,26 @@
+# Summary
+
+- [什么是 RustSBI?](./chapter_01_what_is_rustsbi.md)
+- [RustSBI 核心库](./chapter_02_libraries.md)
+    - [`rustsbi` 核心抽象库](./02_libraries/01_rustsbi.md)
+    - [`sbi-rt` 特权态运行环境](./02_libraries/02_sbi_rt.md)
+    - [`sbi-spec` 常量与常数库](./02_libraries/03_sbi_spec.md)
+    - [`sbi-testing` 测试环境库](./02_libraries/04_sbi_testing.md)
+- [RustSBI Prototyper](./chapter_03_prototyper.md)
+- [RustSBI 维护的裸机支持包](./chapter_04_hal.md)
+    - [`allwnner-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)
+- [附录](./appendix.md)

+ 1 - 0
docs/src/appendix.md

@@ -0,0 +1 @@
+# 附录

+ 1 - 0
docs/src/chapter_01_what_is_rustsbi.md

@@ -0,0 +1 @@
+# 什么是 RustSBI?

+ 1 - 0
docs/src/chapter_02_libraries.md

@@ -0,0 +1 @@
+# RustSBI 核心库

+ 1 - 0
docs/src/chapter_03_prototyper.md

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

+ 1 - 0
docs/src/chapter_04_hal.md

@@ -0,0 +1 @@
+# RustSBI 维护的裸机支持包

+ 1 - 0
docs/src/chapter_05.md

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

+ 1 - 0
docs/src/chapter_06_incubating.md

@@ -0,0 +1 @@
+# 孵化中的 RustSBI 项目

+ 1 - 0
docs/src/chapter_07_oss_guide.md

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