docs: improve installation guide and restructure documentation configuration

- Updated Installation section with clearer step-by-step instructions
- Improved project structure explanation
- Refactored configuration documentation for better clarity
- Reorganized headings and subsections for consistency
- Fixed formatting and minor inconsistencies

Author: mathsvisualization

.github/workflows/docs.yml

@@ -1,6 +1,6 @@
 name: docs
 
-on: 
+on:
   push:
     paths:
       - 'docs/**'
@@ -10,31 +10,38 @@ on:
 
 jobs:
   docs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     name: build up document and deploy
 
     steps:
     - name: Checkout
-      uses: actions/checkout@master
-    
-    - name: Install sphinx and manim env
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+
+    - name: Install system dependencies
       run: |
-        pip3 install --upgrade pip
-        sudo apt install python3-setuptools libpango1.0-dev
-        pip3 install -r docs/requirements.txt
-        pip3 install -r requirements.txt
-    
+        sudo apt-get update
+        sudo apt-get install -y python3-setuptools libpango1.0-dev
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r docs/requirements.txt
+        pip install -r requirements.txt
+
     - name: Build document with Sphinx
       run: |
         cd docs
-        export PATH="$PATH:/home/runner/.local/bin"
-        export SPHINXBUILD="python3 -m sphinx"
         make html
-        
+
     - name: Deploy to GitHub pages
       if: ${{ github.event_name == 'push' }}
-      uses: JamesIves/github-pages-deploy-action@3.7.1
+      uses: JamesIves/github-pages-deploy-action@v4
       with:
-        ACCESS_TOKEN: ${{ secrets.DOC_DEPLOY_TOKEN }}
-        BRANCH: gh-pages
-        FOLDER: docs/build/html
+        token: ${{ secrets.GITHUB_TOKEN }}
+        branch: gh-pages
+        folder: docs/build/html

docs/source/development/about.rst

@@ -4,28 +4,43 @@ About
 About Manim
 -----------
 
-Manim is an animation engine for explanatory math videos. 
-You can use it to make math videos (or other fields) like 3Blue1Brown.
+Manim is a powerful animation engine designed for creating 
+**explanatory math videos**.
+It is widely used to create videos similar to those of 3Blue1Brown,
+but it can also be applied to other domains that require precise
+and visually appealing animations.
 
-There are mainly two versions here:
+There are mainly **two versions** of Manim:
 
-- `3b1b/manim <https://github.com/3b1b/manim>`_ : Maintained by Grant Sanderson of 3Blue1Brown.
+- `3b1b/manim <https://github.com/3b1b/manim>`__
+  
+  Maintained by Grant Sanderson of 3Blue1Brown.
 
-Using OpenGL and its GLSL language to use GPU for rendering. It has higher efficiency, 
-faster rendering speed, and supports real-time rendering and interaction.
+  - Uses **OpenGL** and its **GLSL language** to leverage the GPU.
+  - Offers higher efficiency, faster rendering, and real-time interaction.
+  - Best suited for high-quality production-ready videos.
 
-- `ManimCommunity/manim <https://github.com/ManimCommunity/manim>`_ : Maintained by Manim Community Dev Team.
+- `ManimCommunity/manim <https://github.com/ManimCommunity/manim>`__
+  
+  Maintained by the Manim Community Development Team.
 
-Using multiple backend rendering. There is better documentation and 
-a more open contribution community.
+  - Uses multiple backend rendering options.
+  - Provides better documentation and open contribution workflow.
+  - Ideal for learners and educators.
 
-About this documentation
+About this Documentation
 ------------------------
 
-This documentation is based on the version in `3b1b/manim <https://github.com/3b1b/manim>`_. 
-Created by `TonyCrane <https://github.com/TonyCrane>`_ ("鹤翔万里" in Chinese) and in production.
+This documentation is primarily based on:
 
-Among them, the ``manim_example_ext`` extension for Sphinx refers to 
-`the documentation of ManimCommunity <https://docs.manim.community/>`_.
+`3b1b/manim <https://github.com/3b1b/manim>`__
 
-If you want to contribute to manim or this document, please see: :doc:`contributing`
+- Created by `TonyCrane <https://github.com/TonyCrane>`__.
+- Continuously updated for clarity and accuracy.
+
+.. note::
+
+   Some features such as ``manim_example_ext`` are inspired by
+   the `ManimCommunity documentation <https://docs.manim.community/>`__.
+
+If you want to contribute, please see :doc:`contributing`.

docs/source/development/contributing.rst

@@ -1,59 +1,81 @@
 Contributing
 ============
 
-Accept any contribution you make :)
+We welcome and appreciate any contributions you make to Manim! :)
 
-- **Contribute to the manim source code**: 
+Contributing to the Source Code
+-------------------------------
 
-Please fork to your own repository and make changes, submit a pull request, and fill in 
-the motivation for the change following the instructions in the template. We will check 
-your pull request in detail (this usually takes a while, please be patient)
+- **Fork the repository** to your own GitHub account.
+- Make your changes locally.
+- Submit a **pull request** to the main repository.
+- Fill in the **motivation for your change** following the instructions in the provided template.
 
-- **Contribute to the documentation**: 
+.. note::
 
-Also submit a pull request and write down the main changes.
+    Pull requests will be reviewed in detail. This process may take some time, so please be patient.
 
-- **If you find a bug in the code**: 
+Contributing to the Documentation
+---------------------------------
 
-Please open an issue and fill in the found problem and your environment according 
-to the template. (But please note that if you think this problem is just a problem 
-of yourself, rather than a problem of source code, it is recommended that you ask a 
-question in the `Q&A category <https://github.com/3b1b/manim/discussions/categories/q-a>`_ 
-of the discussion page)
+- Make edits to the documentation files in your fork.
+- Submit a **pull request** describing the main changes you made.
 
-- **You are welcome to share the content you made with manim**: 
+Reporting Bugs
+--------------
 
-Post it in the `show and tell category <https://github.com/3b1b/manim/discussions/categories/show-and-tell>`_
-of the discussion page.
+If you find a bug in the code:
 
-- **You are also welcome to share some of your suggestions and ideas**: 
+1. Open a new **issue** in the repository.
+2. Describe the problem clearly.
+3. Include details about your **environment** (Python version, OS, Manim version, etc.) according to the issue template.
 
-Post them in the `ideas category <https://github.com/3b1b/manim/discussions/categories/ideas>`_ 
-of the discussion page.
+.. note::
 
-How to build this documentation
--------------------------------
+    If you suspect the problem is local to your setup rather than the source code, it is recommended to ask a question in the
+    `Q&A category <https://github.com/3b1b/manim/discussions/categories/q-a>`_ of the discussion page.
+
+Sharing Your Work
+-----------------
+
+- You are welcome to share content you created using Manim.
+- Post it in the `Show and Tell category <https://github.com/3b1b/manim/discussions/categories/show-and-tell>`_ of the discussion page.
+
+Sharing Ideas and Suggestions
+-----------------------------
 
-- Clone the 3b1b/manim repository
+- Suggestions, feature requests, and ideas are encouraged!
+- Post them in the `Ideas category <https://github.com/3b1b/manim/discussions/categories/ideas>`_ of the discussion page.
+
+How to Build the Documentation
+------------------------------
+
+Follow these steps to build the Manim documentation locally:
+
+1. **Clone the repository**
 
 .. code-block:: sh
 
     git clone https://github.com/3b1b/manim.git
-    # or your own repo
-    # git clone https://github.com/<your user name>/manim.git
+    # Or clone your own fork
+    # git clone https://github.com/<your-username>/manim.git
     cd manim
 
-- Install python package dependencies
+2. **Install Python package dependencies**
 
 .. code-block:: sh
 
     pip install -r docs/requirements.txt
 
-- Go to the ``docs/`` folder and build
+3. **Navigate to the docs folder and build HTML**
 
 .. code-block:: sh
 
     cd docs/
     make html
 
-- The output document is located in ``docs/build/html/``
+4. **Find the built documentation**
+
+    The output HTML files will be located in::
+
+        docs/build/html/