diff --git a/docs/_config.yml b/docs/_config.yml
index 71131dbf..d23da483 100644
--- a/docs/_config.yml
+++ b/docs/_config.yml
@@ -2,9 +2,12 @@
# Learn more at https://jupyterbook.org/customize/config.html
project: "ReMe"
-title: "ReMe
"
+title: "
+ AgentScope
+ ReMe
+
"
author: Alibaba Tongyi Lab
-logo: _static/figure/reme_logo.png
+logo: _static/figure/logo.svg
copyright: "2025, Tongyi Lab, Alibaba Inc."
only_build_toc_files: true
@@ -31,6 +34,7 @@ html:
- _static/memory-lib/memory-lib.js
extra_css:
- _static/memory-lib/memory-lib.css
+ - _static/custom.css
# Sphinx settings
sphinx:
@@ -40,6 +44,7 @@ sphinx:
- sphinx.ext.napoleon
- sphinx.ext.intersphinx
- sphinx.ext.autosummary
+ - sphinxcontrib.mermaid
config:
# API Documentation Configuration
autosummary_generate: True
@@ -86,7 +91,6 @@ sphinx:
use_multitoc_numbering: false
html_js_files:
- language.js
-
html_css_files:
- custom.css
html_sidebars:
@@ -103,6 +107,14 @@ sphinx:
source_repository: "https://github.com/modelscope/ReMe"
source_branch: "main"
source_directory: "docs/"
+ footer_icons:
+ - name: GitHub
+ url: "https://github.com/modelscope/ReMe"
+ html: |
+
+ class: ""
light_css_variables:
color-brand-primary: "#2196f3"
color-brand-content: "#2196f3"
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
index 2143cda6..81ec0ad6 100644
--- a/docs/_static/custom.css
+++ b/docs/_static/custom.css
@@ -20,4 +20,14 @@ h5, .bd-article h5 {
h6, .bd-article h6 {
font-size: 0.9rem !important;
-}
\ No newline at end of file
+}
+
+div.bd-sidebar .navbar-brand {
+ text-align: center;
+ width: 100%;
+}
+
+div.bd-sidebar .navbar-brand span {
+ display: block;
+ text-align: center;
+}
diff --git a/docs/_static/figure/logo.svg b/docs/_static/figure/logo.svg
new file mode 100644
index 00000000..e781d9c8
--- /dev/null
+++ b/docs/_static/figure/logo.svg
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/docs/quick_start.md b/docs/quick_start.md
index cc15174f..8e190039 100644
--- a/docs/quick_start.md
+++ b/docs/quick_start.md
@@ -59,9 +59,8 @@ response = requests.post("http://localhost:8002/retrieve_task_memory", json={
})
```
-
-curl version
+````{dropdown} curl version
```bash
# Experience Summarizer: Learn from execution trajectories
curl -X POST http://localhost:8002/summary_task_memory \
@@ -82,12 +81,9 @@ curl -X POST http://localhost:8002/retrieve_task_memory \
"top_k": 1
}'
```
+````
-
-
-
-Node.js version
-
+````{dropdown} Node.js version
```{code-block} javascript
// Experience Summarizer: Learn from execution trajectories
fetch("http://localhost:8002/summary_task_memory", {
@@ -120,8 +116,7 @@ fetch("http://localhost:8002/retrieve_task_memory", {
.then(response => response.json())
.then(data => console.log(data));
```
-
-
+````
#### Personal Memory Management
@@ -148,8 +143,7 @@ response = requests.post("http://localhost:8002/retrieve_personal_memory", json=
})
```
-
-curl version
+````{dropdown} curl version
```bash
# Memory Integration: Learn from user interactions
@@ -174,11 +168,9 @@ curl -X POST http://localhost:8002/retrieve_personal_memory \
"top_k": 5
}'
```
+````
-
-
-
-Node.js version
+````{dropdown} Node.js version
```{code-block} javascript
// Memory Integration: Learn from user interactions
@@ -215,8 +207,8 @@ fetch("http://localhost:8002/retrieve_personal_memory", {
.then(response => response.json())
.then(data => console.log(data));
```
+````
-
#### Tool Memory Management
@@ -252,8 +244,8 @@ response = requests.post("http://localhost:8002/retrieve_tool_memory", json={
})
```
-
-curl version
+
+````{dropdown} curl version
```bash
# Record tool execution results
@@ -290,11 +282,9 @@ curl -X POST http://localhost:8002/retrieve_tool_memory \
"tool_names": "web_search"
}'
```
+````
-
-
-
-Node.js version
+````{dropdown} Node.js version
```{code-block} javascript
// Record tool execution results
@@ -349,5 +339,4 @@ fetch("http://localhost:8002/retrieve_tool_memory", {
.then(response => response.json())
.then(data => console.log(data));
```
-
-
\ No newline at end of file
+````
\ No newline at end of file
diff --git a/docs/tool_memory/tool_memory.md b/docs/tool_memory/tool_memory.md
index aa6ccca6..077ac859 100644
--- a/docs/tool_memory/tool_memory.md
+++ b/docs/tool_memory/tool_memory.md
@@ -191,7 +191,7 @@ class ToolCallResult(BaseModel):
### Tool Memory Lifecycle
-```mermaid
+```{mermaid}
graph LR
A[Tool Call] --> B[Evaluate]
B --> C[Store Memory]
@@ -206,7 +206,7 @@ graph LR
Tool Memory operates through three complementary operations that work together to create a learning loop:
-```mermaid
+```{mermaid}
graph LR
A[Agent] -->|1 retrieve_tool_memory| B[(Vector Store)]
B -->|Guidelines| A