Document in High-level (#93)

* Add init information

* Adjust order and move content

* GPU support

* edit docs

* README structure

* Update Dockerfile

* Update rdagent/utils/env.py

* Update read the docs

* Update framework

docs/api_reference.rst

@@ -1,18 +1,15 @@
-=========================
-API reference
-=========================
+=============
+API Reference
+=============
 
-title1
-=========================
+Here you can find all ``RDAgent``'s interfaces.
 
-content1
 
-title2
-=========================
+RD Loop
+=======
 
-content2
+Research
+--------
 
-title3
-=========================
-
-content3
+.. automodule:: rdagent.core.proposal
+    :members:

docs/conf.py

@@ -15,7 +15,9 @@ author = "Microsoft"
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = [
+    'sphinx.ext.autodoc',
+]
 
 autodoc_member_order = "bysource"
 

docs/demo_and_introduction.rst

@@ -2,17 +2,17 @@
 Demo and Introduction
 =========================
 
-title1
-=========================
+Introduction
+============
 
-content1
+TODO: copy the content in the README.md
 
-title2
-=========================
+A Quick Demo
+============
 
-content2
+TODO:
+- copy the demo content in the README.md
+- Quick start for the demo.
 
-title3
-=========================
 
-content3
+TODO: link to more demos

docs/development.rst

@@ -2,17 +2,69 @@
 For Development
 =========================
 
-title1
+🔧Prepare for development
 =========================
 
-content1
+- Set up the development environment.
 
-title2
+   ```bash
+   make dev
+   ```
+
+- Run linting and formatting.
+
+   ```bash
+   make lint
+   ```
+
+
+Code Structure
 =========================
 
-content2
+.. code-block:: text
 
-title3
-=========================
+    📂 src
+    ➥ 📂 <project name>: avoid namespace conflict
+      ➥ 📁 core
+      ➥ 📁 components/A
+      ➥ 📁 components/B
+      ➥ 📁 components/C
+      ➥ 📁 scenarios/X
+      ➥ 📁 scenarios/Y
+      ➥ 📂 app
+    ➥ 📁 scripts
 
-content3
+.. list-table::
+   :header-rows: 1
+
+   * - Folder Name
+     - Description
+   * - 📁 core
+     - The core framework of the system. All classes should be abstract and usually can't be used directly.
+   * - 📁 component/A
+     - Useful components that can be used by others (e.g., scenarios). Many subclasses of core classes are located here.
+   * - 📁 scenarios/X
+     - Concrete features for specific scenarios (usually built based on components or core). These modules are often unreusable across scenarios.
+   * - 📁 app
+     - Applications for specific scenarios (usually built based on components or scenarios). Removing any of them does not affect the system's completeness or other scenarios.
+   * - 📁 scripts
+     - Quick and dirty things. These are candidates for core, components, scenarios, and apps.
+
+
+
+Conventions
+===========
+
+
+File Naming Convention
+----------------------
+
+.. list-table::
+   :header-rows: 1
+
+   * - Name
+     - Description
+   * - `conf.py`
+     - The configuration for the module, app, and project.
+
+<!-- TODO: renaming files -->

docs/index.rst

@@ -7,16 +7,18 @@ Welcome to RDAgent's documentation!
 ===================================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Doctree:
 
+   demo_and_introduction
    installation
+   scenarios_and_quickstart
+   project_framework_introduction
    development
    api_reference
-   demo_and_introduction
-   project_framework_introduction
-   scenarios_and_quickstart
-   test_dropdown/test1
+   policy
+
+.. test_dropdown/test1
 
 
 Indices and tables

docs/installation.rst

@@ -2,17 +2,14 @@
 Installation
 =========================
 
-title1
-=========================
+Installation
+============
 
-content1
+For different scenarios
+- for purely users:
+- for dev users: link to development
 
-title2
-=========================
+Configuration
+=============
 
-content2
-
-title3
-=========================
-
-content3
+Quick configuration

docs/project_framework_introduction.rst

@@ -1,18 +1,27 @@
 ===============================
-Project framework introduction
+Framework Design & Components
 ===============================
 
-title1
+Framework & Components
 =========================
 
-content1
+- TODO: Components & Feature Level
 
-title2
+- Class Level Figure
+
+Detailed Design
 =========================
 
-content2
 
-title3
-=========================
+Configuration
+-------------
+
+You can manually source the `.env` file in your shell before running the Python script:
+Most of the workflow are controlled by the environment variables.
+```sh
+# Export each variable in the .env file; Please note that it is different from `source .env` without export
+export $(grep -v '^#' .env | xargs)
+# Run the Python script
+python your_script.py
+```
 
-content3

docs/scenarios_and_quickstart.rst

@@ -2,17 +2,32 @@
 Scenarios and Quick Start
 =========================
 
-title1
+Scenario lists
 =========================
 
-content1
+TODO: Copy the content in the README.md
 
-title2
+
+Scnarios' demo & quick start
 =========================
 
-content2
+Scen1
+-----
 
-title3
-=========================
+Scen1 Intro
+~~~~~~~~~~~
+
+Scen1 Demo
+~~~~~~~~~~
+
+Scen1 Quick Start
+~~~~~~~~~~~~~~~~~
+
+
+
+
+
+Usage of modules
+================
+TODO: Show some examples:
 
-content3

docs/test_dropdown/test1.rst

@@ -25,4 +25,4 @@ content3
    :caption: Doctree:
    :hidden:
 
-   test2
+   test2