:doc: 优化文档框架结构

2025-06-08 18:26:48 +00:00 · 2022-06-29 00:16:50 +08:00 · 2022-06-29 00:16:50 +08:00 · b6d1702c14
commit b6d1702c14
parent 6a2ed3c4ee
11 changed files with 42 additions and 25 deletions
--- a/docs/community/code_contribution/index.rst
+++ b/docs/community/code_contribution/index.rst
@ -0,0 +1,4 @@
+代码规范
+====================================
+
+[内容待完善]
--- a/docs/community/contact/index.rst
+++ b/docs/community/contact/index.rst
@ -0,0 +1,4 @@
+与社区建立联系
+====================================
+
+[内容待完善]
--- a/docs/index.rst
+++ b/docs/index.rst
@ -10,27 +10,37 @@
   :maxdepth: 1
   :caption: 入门

-   introduction/index
+   introduction/intro
+   introduction/build_system

 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
   :caption: 内核层

-   kernel/index
+   kernel/bootloader/index
+   kernel/process_management/index
+   kernel/filesystem/index


 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
   :caption: 应用层

-   userland/index
+   userland/libc/index

 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
   :caption: 系统调用api文档

   syscall_api/index

+.. toctree::
+   :maxdepth: 1
+   :caption: DragonOS社区
+
+   community/code_contribution/index
+   community/contact/index
+

 Indices and tables
 ==================
--- a/docs/introduction/intro.md
+++ b/docs/introduction/intro.md
@ -1,3 +1,3 @@
-# 简介
+# DragonOS简介

 DragonOS龙操作系统（以下简称“DragonOS”）是一个基于x86-64体系结构开发的，基于GPLv2协议开放源代码的64位操作系统。
--- a/docs/kernel/process_management/index.rst
+++ b/docs/kernel/process_management/index.rst
@ -0,0 +1,4 @@
+进程管理模块
+====================================
+
+[内容待完善]
--- a/docs/userland/index.rst
+++ b/docs/userland/index.rst
@ -1,9 +0,0 @@
-应用层
-====================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: 目录
-
-   intro
-   libc/index
--- a/docs/userland/intro.md
+++ b/docs/userland/intro.md
@ -1 +0,0 @@
-# 简介
--- a/docs/userland/libc/apis/index.rst
+++ b/docs/userland/libc/apis/index.rst
@ -1,9 +1,9 @@
-入门
+API文档
 ====================================

 .. toctree::
   :maxdepth: 1
   :caption: 目录

-   intro
-   build_system
+
+[内容待完善]
--- a/docs/userland/libc/design/index.rst
+++ b/docs/userland/libc/design/index.rst
@ -1,9 +1,9 @@
-内核层
+设计文档
 ====================================

 .. toctree::
   :maxdepth: 1
   :caption: 目录

-   bootloader/index
-   filesystem/index
+   
+[内容待完善]
--- a/docs/userland/libc/index.rst
+++ b/docs/userland/libc/index.rst
@ -3,6 +3,8 @@ LibC文档

 .. toctree::
   :maxdepth: 1
-   :caption: LibC
+   :caption: 目录

   intro
+   apis/index
+   design/index
--- a/docs/userland/libc/intro.md
+++ b/docs/userland/libc/intro.md
@ -1 +1,4 @@
 # 简介
+&nbsp;
+    LibC是连接用户程序和操作系统的纽带，LibC为应用程序提供了一系列标准库函数。应用程序可以通过DragonOS的LibC，快速地与操作系统进行交互。
+    DragonOS的LibC主要依照POSIX 2008规范实现，与Linux下的glibC具有相似之处。