From a99d0062daa056f912bf3245b1a1ff80453c34b2 Mon Sep 17 00:00:00 2001
From: HsiangNianian <i@jyunko.cn>
Date: Sun, 12 Jan 2025 14:42:32 +0800
Subject: [PATCH] feat: update documentation formatting and improve
 contributing guidelines

---
 .github/copilot-instructions.md |  2 +-
 README.rst                      | 25 ++++++++++++-------------
 2 files changed, 13 insertions(+), 14 deletions(-)

diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md
index 50c0b027..93443b03 100644
--- a/.github/copilot-instructions.md
+++ b/.github/copilot-instructions.md
@@ -4,4 +4,4 @@ We use pyo3 to bradge rust and python.
 
 This project is a rule-driven and powerful AI framework designed to support multimodal machine learning and cross-platform robot development.
 
-We use ruff to format and lint code.
\ No newline at end of file
+We use ruff to format and lint code, we use .rst grammar to write the README.rst and all the docstring in English.
diff --git a/README.rst b/README.rst
index b102d480..8a649868 100644
--- a/README.rst
+++ b/README.rst
@@ -24,18 +24,18 @@ Installation
 
 To install **iamai**, run the following command:
 
-```bash
-pip install iamai
-```
+.. code-block:: bash
+
+    pip install iamai
 
 Usage
 -----
 
 To use **iamai**, run the following command:
 
-```bash
-iamai
-```
+.. code-block:: bash
+
+    iamai
 
 Contributing
 ------------
@@ -43,20 +43,19 @@ Contributing
 To contribute to **iamai**, follow these steps:
 
 1. Fork this repository.
-2. Create a branch: `git checkout -b <branch_name>`.
-3. Make your changes and commit them: `git commit -m '<commit_message>'`.
-4. Push to the original branch: `git push origin <project_name>/<location>`.
+2. Create a branch: ``git checkout -b <branch_name>``.
+3. Make your changes and commit them: ``git commit -m '<commit_message>'``.
+4. Push to the original branch: ``git push origin <project_name>/<location>``.
 5. Create the pull request.
 
-Alternatively, see the GitHub documentation on [creating a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
+Alternatively, see the GitHub documentation on `creating a pull request <https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request>`_.
 
 Support
 -------
 
-If you have any questions, please contact me at [academic@jyunko.cn](mailto:academic@jyunko.cn).
-
+If you have any questions, please contact me at `academic@jyunko.cn <mailto:academic@jyunko.cn>`_.
 
 License
 -------
 
-This project is licensed under the AGPLv3 License. See the [COPYING](COPYING) file for details.
+This project is licensed under the AGPLv3 License. See the `COPYING <COPYING>`_ file for details.
\ No newline at end of file