Skip to content

armgit / camel

Public Imported from GitHub
0

🐫 CAMEL: The first and the best multi-agent framework. Finding the Scaling Law of Agents. https://www.camel-ai.org

chore: Doc ci enhance (#2580)

Tao Sunbebf89e13898
diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml
index 7f4227aa4..f67be987d 100644
--- a/.github/workflows/documentation.yml
+++ b/.github/workflows/documentation.yml
@@ -30,74 +30,38 @@ jobs:
- name: Convert Cookbooks and Update Mintlify Config
run: |
source .venv/bin/activate
- if [ "${{ github.event_name }}" = "push" ]; then
- echo "Push event detected - using incremental mode for cookbooks"
- python docs/mintlify/convert_notebook2mdx.py \
- --input docs/cookbooks \
- --output docs/mintlify \
- --update-docs-json docs/mintlify/docs.json \
- --docs-path-prefix "" \
- --incremental \
- --use-git \
- --base-branch origin/master \
- --verbose
- else
- echo "Manual workflow - processing all cookbooks files"
- python docs/mintlify/convert_notebook2mdx.py \
- --input docs/cookbooks \
- --output docs/mintlify \
- --update-docs-json docs/mintlify/docs.json \
- --docs-path-prefix "" \
- --verbose
- fi
+ echo "Manual workflow - processing all cookbooks files"
+
+ python docs/mintlify/convert_notebook2mdx.py \
+ --input docs/cookbooks \
+ --output docs/mintlify \
+ --update-docs-json docs/mintlify/docs.json \
+ --docs-path-prefix "" \
+ --verbose
- name: Convert Get Started docs
run: |
source .venv/bin/activate
- if [ "${{ github.event_name }}" = "push" ]; then
- echo "Push event detected - using incremental mode for get_started"
- python docs/mintlify/convert_notebook2mdx.py \
- --input docs/get_started \
- --output docs/mintlify \
- --update-docs-json docs/mintlify/docs.json \
- --docs-path-prefix "" \
- --incremental \
- --use-git \
- --base-branch origin/master \
- --verbose
- else
- echo "Manual workflow - processing all get_started files"
- python docs/mintlify/convert_notebook2mdx.py \
- --input docs/get_started \
- --output docs/mintlify \
- --update-docs-json docs/mintlify/docs.json \
- --docs-path-prefix "" \
- --verbose
- fi
+ echo "Manual workflow - processing all get_started files"
+
+ python docs/mintlify/convert_notebook2mdx.py \
+ --input docs/get_started \
+ --output docs/mintlify \
+ --update-docs-json docs/mintlify/docs.json \
+ --docs-path-prefix "" \
+ --verbose
- name: Convert Key Modules docs
run: |
source .venv/bin/activate
- if [ "${{ github.event_name }}" = "push" ]; then
- echo "Push event detected - using incremental mode for key_modules"
- python docs/mintlify/convert_notebook2mdx.py \
- --input docs/key_modules \
- --output docs/mintlify \
- --update-docs-json docs/mintlify/docs.json \
- --docs-path-prefix "" \
- --incremental \
- --use-git \
- --base-branch origin/master \
- --verbose
- else
- echo "Manual workflow - processing all key_modules files"
- python docs/mintlify/convert_notebook2mdx.py \
- --input docs/key_modules \
- --output docs/mintlify \
- --update-docs-json docs/mintlify/docs.json \
- --docs-path-prefix "" \
- --verbose
- fi
+
+ echo "Manual workflow - processing all key_modules files"
+ python docs/mintlify/convert_notebook2mdx.py \
+ --input docs/key_modules \
+ --output docs/mintlify \
+ --update-docs-json docs/mintlify/docs.json \
+ --docs-path-prefix "" \
+ --verbose
- name: Generate API Documentation
run: |
diff --git a/docs/cookbooks/advanced_features/agents_tracking.ipynb b/docs/cookbooks/advanced_features/agents_tracking.ipynb
index fa6802cb6..1cb86c9d8 100644
--- a/docs/cookbooks/advanced_features/agents_tracking.ipynb
+++ b/docs/cookbooks/advanced_features/agents_tracking.ipynb
@@ -419,7 +419,7 @@
}
],
"source": [
- "agentops.start_session(tags=[\"CAMEL X AgentOps Multi-agent with Tools\"])\n",
+ "agentops.start_session(tags=[\"CAMEL X AgentOps Multi-agent with Tools.\"])\n",
"\n",
"from camel.toolkits import (\n",
" SearchToolkit,\n",
diff --git a/docs/mintlify/cookbooks/advanced_features/agents_tracking.mdx b/docs/mintlify/cookbooks/advanced_features/agents_tracking.mdx
index ada32b585..4b34c7b1b 100644
--- a/docs/mintlify/cookbooks/advanced_features/agents_tracking.mdx
+++ b/docs/mintlify/cookbooks/advanced_features/agents_tracking.mdx
@@ -16,7 +16,7 @@ First, install the CAMEL and AgentOps package with all its dependencies:
```python
-%pip install camel-ai[all]==0.2.16
+%pip install camel-ai[all]==0.2.18
%pip install agentops==0.3.10
```
@@ -41,7 +41,7 @@ You can go to [here](https://app.agentops.ai/signin) to get **free** API Key fro
```python
# Prompt for the AgentOps API key securely
-agentops_api_key = getpass('Enter your API key: ')
+agentops_api_key = getpass('Enter your API key:')
os.environ["AGENTOPS_API_KEY"] = agentops_api_key
```
@@ -89,7 +89,7 @@ Set one Agent with Search Tools
```python
# Define system message
sys_msg = BaseMessage.make_assistant_message(
- role_name='Tools calling opertor', content='You are a helpful assistant'
+ role_name='Tools calling opertor', content='You are a helpful assistant '
)
# Set model config