Browse Source

:doc: 优化文档框架结构

longjin 2 years ago
parent
commit
b6d1702c14

+ 4 - 0
docs/community/code_contribution/index.rst

@@ -0,0 +1,4 @@
+代码规范
+====================================
+
+[内容待完善]

+ 4 - 0
docs/community/contact/index.rst

@@ -0,0 +1,4 @@
+与社区建立联系
+====================================
+
+[内容待完善]

+ 16 - 6
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
 ==================

+ 1 - 1
docs/introduction/intro.md

@@ -1,3 +1,3 @@
-# 简介
+# DragonOS简介
 
 DragonOS龙操作系统(以下简称“DragonOS”)是一个基于x86-64体系结构开发的,基于GPLv2协议开放源代码的64位操作系统。

+ 4 - 0
docs/kernel/process_management/index.rst

@@ -0,0 +1,4 @@
+进程管理模块
+====================================
+
+[内容待完善]

+ 0 - 9
docs/userland/index.rst

@@ -1,9 +0,0 @@
-应用层
-====================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: 目录
-
-   intro
-   libc/index

+ 0 - 1
docs/userland/intro.md

@@ -1 +0,0 @@
-# 简介

+ 3 - 3
docs/introduction/index.rst → docs/userland/libc/apis/index.rst

@@ -1,9 +1,9 @@
-入门
+API文档
 ====================================
 
 .. toctree::
    :maxdepth: 1
    :caption: 目录
 
-   intro
-   build_system
+
+[内容待完善]

+ 3 - 3
docs/kernel/index.rst → docs/userland/libc/design/index.rst

@@ -1,9 +1,9 @@
-内核层
+设计文档
 ====================================
 
 .. toctree::
    :maxdepth: 1
    :caption: 目录
 
-   bootloader/index
-   filesystem/index
+   
+[内容待完善]

+ 3 - 1
docs/userland/libc/index.rst

@@ -3,6 +3,8 @@ LibC文档
 
 .. toctree::
    :maxdepth: 1
-   :caption: LibC
+   :caption: 目录
 
    intro
+   apis/index
+   design/index

+ 4 - 1
docs/userland/libc/intro.md

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