From 5687f23b56bf55cfef85144ee57ddde9a530213b Mon Sep 17 00:00:00 2001
From: Jianfeng Jiang <jiangjianfeng.jjf@antgroup.com>
Date: Mon, 27 May 2024 02:47:43 +0000
Subject: [PATCH] Add API documentation guidelines in to-contribute

---
 docs/src/SUMMARY.md                               |  2 +-
 .../style-guidelines/general-guidelines.md        |  2 +-
 .../style-guidelines/git-guidelines.md            |  2 +-
 .../style-guidelines/rust-guidelines.md           | 15 ++++++++++++++-
 4 files changed, 17 insertions(+), 4 deletions(-)

diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
index 89d4d802d..59c314a99 100644
--- a/docs/src/SUMMARY.md
+++ b/docs/src/SUMMARY.md
@@ -38,7 +38,7 @@
 * [Code Organization]()
 * [Style Guidelines]()
     * [General Guidelines]() 
-    * [Rust Guidelines]() 
+    * [Rust Guidelines](to-contribute/style-guidelines/rust-guidelines.md) 
     * [Git Guidelines]() 
 * [Community]()
 * [Code of Conduct]()
diff --git a/docs/src/to-contribute/style-guidelines/general-guidelines.md b/docs/src/to-contribute/style-guidelines/general-guidelines.md
index 6474f1f55..6ddc5603e 100644
--- a/docs/src/to-contribute/style-guidelines/general-guidelines.md
+++ b/docs/src/to-contribute/style-guidelines/general-guidelines.md
@@ -1 +1 @@
-# General Guidlines
+# General Guidelines
diff --git a/docs/src/to-contribute/style-guidelines/git-guidelines.md b/docs/src/to-contribute/style-guidelines/git-guidelines.md
index ab6fa5074..77ac6c786 100644
--- a/docs/src/to-contribute/style-guidelines/git-guidelines.md
+++ b/docs/src/to-contribute/style-guidelines/git-guidelines.md
@@ -1 +1 @@
-# Commit Guidlines
+# Commit Guidelines
diff --git a/docs/src/to-contribute/style-guidelines/rust-guidelines.md b/docs/src/to-contribute/style-guidelines/rust-guidelines.md
index ea2774614..5479f0ef9 100644
--- a/docs/src/to-contribute/style-guidelines/rust-guidelines.md
+++ b/docs/src/to-contribute/style-guidelines/rust-guidelines.md
@@ -1 +1,14 @@
-# Rust Guidlines
+# Rust Guidelines
+
+## API Documentation Guidelines
+
+API documentation describes the meanings and usage of APIs,
+and will be rendered into web pages by rustdoc.
+
+It is necessary to add documentation to all public APIs,
+including crates, modules, structs, traits, functions, macros, and more.
+The use of the `#[warn(missing_docs)]` lint enforces this rule.
+
+Asterinas adheres to the API style guidelines of the Rust community.
+The recommended API documentation style can be found at
+[how-to-write-documentation](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html).