Skip to content

Commit 4336564

Browse files
raychen911raychen911
authored
docs: add docs index (#146)
1 parent f10f08c commit 4336564

5 files changed

Lines changed: 224 additions & 0 deletions

File tree

‎.github/workflows/docs.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- "docs/mkdocs/**"
9+
- "mkdocs.yml"
10+
- ".github/workflows/docs.yml"
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: read
15+
pages: write
16+
id-token: write
17+
18+
concurrency:
19+
group: pages
20+
cancel-in-progress: false
21+
22+
jobs:
23+
build:
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v4
28+
29+
- name: Set up Python
30+
uses: actions/setup-python@v5
31+
with:
32+
python-version: "3.11"
33+
34+
- name: Install MkDocs
35+
run: python -m pip install --upgrade pip mkdocs
36+
37+
- name: Build documentation
38+
run: mkdocs build
39+
40+
- name: Upload artifact
41+
uses: actions/upload-pages-artifact@v3
42+
with:
43+
path: site
44+
45+
deploy:
46+
environment:
47+
name: github-pages
48+
url: ${{ steps.deployment.outputs.page_url }}
49+
runs-on: ubuntu-latest
50+
needs: build
51+
steps:
52+
- name: Deploy to GitHub Pages
53+
id: deployment
54+
uses: actions/deploy-pages@v4

‎docs/mkdocs/en/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# English Documentation
2+
3+
Welcome to the English documentation for tRPC-Agent-Python.
4+
5+
## Getting Started
6+
7+
- [LLM Agent](./llm_agent.md): Build a general-purpose LLM-powered agent.
8+
- [Model Invocation](./model.md): Configure OpenAI, Anthropic, and LiteLLM models.
9+
- [Tools](./tool.md): Add function tools, file tools, MCP tools, and agent tools.
10+
- [Skills](./skill.md): Package reusable workflows with `SKILL.md`.
11+
- [Code Executor](./code_executor.md): Execute code through local or sandboxed runtimes.
12+
13+
## Core Capabilities
14+
15+
- [Session](./session.md): Manage conversation events and state.
16+
- [Memory](./memory.md): Store and retrieve long-term memories.
17+
- [Knowledge](./knowledge.md): Build RAG workflows with LangChain components.
18+
- [Multi-Agent](./multi_agents.md): Compose agents for complex workflows.
19+
- [Evaluation](./evaluation.md): Evaluate agent behavior and response quality.
20+
21+
For source code and examples, see the [GitHub repository](https://github.com/trpc-group/trpc-agent-python).

‎docs/mkdocs/index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# tRPC-Agent-Python Documentation
2+
3+
tRPC-Agent-Python is a production-grade Agent framework deeply integrated with the Python AI ecosystem. It provides an end-to-end foundation for agent building, orchestration, tool integration, session and long-term memory, service deployment, and observability.
4+
5+
Choose a language to get started:
6+
7+
- [English Documentation](./en/)
8+
- [中文文档](./zh/)
9+
10+
## Quick Links
11+
12+
- [LLM Agent](./en/llm_agent.md)
13+
- [Model Invocation](./en/model.md)
14+
- [Tools](./en/tool.md)
15+
- [Skills](./en/skill.md)
16+
- [Code Executor](./en/code_executor.md)
17+
- [Session](./en/session.md)
18+
- [Memory](./en/memory.md)
19+
20+
## Project
21+
22+
- [GitHub Repository](https://github.com/trpc-group/trpc-agent-python)
23+
- [PyPI Package](https://pypi.org/project/trpc-agent-py/)

‎docs/mkdocs/zh/index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# 中文文档
2+
3+
欢迎阅读 tRPC-Agent-Python 中文文档。
4+
5+
## 快速开始
6+
7+
- [LLM Agent](./llm_agent.md)：构建通用 LLM Agent。
8+
- [模型调用](./model.md)：配置 OpenAI、Anthropic 和 LiteLLM 模型。
9+
- [工具](./tool.md)：接入函数工具、文件工具、MCP 工具和 Agent 工具。
10+
- [Skills](./skill.md)：通过 `SKILL.md` 封装可复用工作流。
11+
- [代码执行器](./code_executor.md)：通过本地或沙箱运行时代码执行。
12+
13+
## 核心能力
14+
15+
- [Session](./session.md)：管理会话事件与状态。
16+
- [Memory](./memory.md)：存储和检索长期记忆。
17+
- [Knowledge](./knowledge.md)：基于 LangChain 组件构建 RAG 工作流。
18+
- [多 Agent](./multi_agents.md)：编排多个 Agent 完成复杂任务。
19+
- [Evaluation](./evaluation.md)：评测 Agent 行为和回复质量。
20+
21+
源码与示例请参考 [GitHub 仓库](https://github.com/trpc-group/trpc-agent-python)。

‎mkdocs.yml‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
site_name: tRPC-Agent-Python
2+
site_description: Python LLM agent framework with multi-model support, tool calling, session management, and service integrations.
3+
site_url: https://trpc-group.github.io/trpc-agent-python/
4+
repo_url: https://github.com/trpc-group/trpc-agent-python
5+
repo_name: trpc-group/trpc-agent-python
6+
docs_dir: docs/mkdocs
7+
site_dir: site
8+
9+
theme:
10+
name: readthedocs
11+
locale: en
12+
13+
markdown_extensions:
14+
- admonition
15+
- fenced_code
16+
- tables
17+
- toc:
18+
permalink: true
19+
20+
nav:
21+
- Home: index.md
22+
- English:
23+
- Overview: en/index.md
24+
- Agent:
25+
- LLM Agent: en/llm_agent.md
26+
- Custom Agent: en/custom_agent.md
27+
- LangGraph Agent: en/langgraph_agent.md
28+
- Claude Agent: en/claude_agent.md
29+
- Multi-Agent: en/multi_agents.md
30+
- Team: en/team.md
31+
- Graph: en/graph.md
32+
- Sub Agent: en/sub_agent.md
33+
- Model: en/model.md
34+
- Tools:
35+
- Tool: en/tool.md
36+
- Code Executor: en/code_executor.md
37+
- Skills: en/skill.md
38+
- Session & Memory:
39+
- Session: en/session.md
40+
- SQL Session: en/session_sql.md
41+
- Redis Session: en/session_redis.md
42+
- Session Summary: en/session_summary.md
43+
- Memory: en/memory.md
44+
- Knowledge:
45+
- Knowledge: en/knowledge.md
46+
- Document Loader: en/knowledge_document_loader.md
47+
- Text Splitter: en/knowledge_text_splitter.md
48+
- Embedder: en/knowledge_embedder.md
49+
- Vector Store: en/knowledge_vectorstore.md
50+
- Retrievers: en/knowledge_retrievers.md
51+
- Prompt Template: en/knowledge_prompt_template.md
52+
- Custom Components: en/knowledge_custom_components.md
53+
- Evaluation & Optimization:
54+
- Evaluation: en/evaluation.md
55+
- Optimization: en/optimization.md
56+
- Integrations:
57+
- A2A: en/a2a.md
58+
- AG-UI: en/agui.md
59+
- OpenClaw: en/openclaw.md
60+
- Runtime:
61+
- Filter: en/filter.md
62+
- Human in the Loop: en/human_in_the_loop.md
63+
- Cancellation: en/cancel.md
64+
- 中文:
65+
- 概览: zh/index.md
66+
- Agent:
67+
- LLM Agent: zh/llm_agent.md
68+
- 自定义 Agent: zh/custom_agent.md
69+
- LangGraph Agent: zh/langgraph_agent.md
70+
- Claude Agent: zh/claude_agent.md
71+
- 多 Agent: zh/multi_agents.md
72+
- Team: zh/team.md
73+
- Graph: zh/graph.md
74+
- Sub Agent: zh/sub_agent.md
75+
- 模型: zh/model.md
76+
- 工具:
77+
- 工具: zh/tool.md
78+
- 代码执行器: zh/code_executor.md
79+
- Skills: zh/skill.md
80+
- Session 与 Memory:
81+
- Session: zh/session.md
82+
- SQL Session: zh/session_sql.md
83+
- Redis Session: zh/session_redis.md
84+
- Session Summary: zh/session_summary.md
85+
- Memory: zh/memory.md
86+
- Knowledge:
87+
- Knowledge: zh/knowledge.md
88+
- 文档加载器: zh/knowledge_document_loader.md
89+
- 文本切分: zh/knowledge_text_splitter.md
90+
- Embedder: zh/knowledge_embedder.md
91+
- Vector Store: zh/knowledge_vectorstore.md
92+
- Retrievers: zh/knowledge_retrievers.md
93+
- Prompt Template: zh/knowledge_prompt_template.md
94+
- 自定义组件: zh/knowledge_custom_components.md
95+
- 评测与优化:
96+
- Evaluation: zh/evaluation.md
97+
- Optimization: zh/optimization.md
98+
- 集成:
99+
- A2A: zh/a2a.md
100+
- AG-UI: zh/agui.md
101+
- OpenClaw: zh/openclaw.md
102+
- 运行时:
103+
- Filter: zh/filter.md
104+
- Human in the Loop: zh/human_in_the_loop.md
105+
- Cancellation: zh/cancel.md

0 commit comments

Comments
 (0)