Skip to content

Commit 0191e83

Browse files
committed
docs(readme): restructure documentation and add technical notes
- Move FlowLLM Development Skill section to consistent location in both READMEs - Add Technical Notes table with Context Management Design and SELFCOMPACT paper notes - Create comprehensive SELFCOMPACT technical documentation covering paper concepts and AgentScope PR implementation - Document core SELFCOMPACT mechanisms including rubric判定 and compression tools - Include experimental results and cost analysis from the original paper - Add AgentScope PR #1938 implementation details and technical evaluation - Maintain compatibility with existing documentation structure and navigation
1 parent 4d7b094 commit 0191e83

3 files changed

Lines changed: 705 additions & 13 deletions

File tree

README.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,6 @@
2121
FlowLLM is a configuration-driven LLM application framework that organizes workflows, service entrypoints, and
2222
long-lived components with **Service, Job, Step, and Component**.
2323

24-
## 🧠 FlowLLM Development Skill
25-
26-
FlowLLM ships with a development Skill for coding agents. It explains the framework conventions, repository map,
27-
extension points, testing workflow, and review checklist for building or extending FlowLLM applications.
28-
29-
Start here when changing the codebase: [FlowLLM Development Skill](skills/flowllm_dev/SKILL.md).
30-
3124
## ✨ Core Features
3225

3326
- **Configuration-driven**: Starts from `flowllm/config/default.yaml`, with config files and dot-notation overrides.
@@ -40,6 +33,20 @@ Start here when changing the codebase: [FlowLLM Development Skill](skills/flowll
4033
<img src="docs/figure/flowllm-architecture.svg" alt="FlowLLM Architecture" width="92%">
4134
</p>
4235

36+
## 🧠 FlowLLM Development Skill
37+
38+
FlowLLM ships with a development Skill for coding agents. It explains the framework conventions, repository map,
39+
extension points, testing workflow, and review checklist for building or extending FlowLLM applications.
40+
41+
Start here when changing the codebase: [FlowLLM Development Skill](skills/flowllm_dev/SKILL.md).
42+
43+
## 📝 Technical Notes
44+
45+
| Note | Description |
46+
|---------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------|
47+
| [Context Management Design](note/context_management_design.md) | Short-term agent context management design, including history compaction and tool-result truncation. |
48+
| [SELFCOMPACT and AgentScope PR #1938](note/self_compact_agentscope_pr.md) | Technical reading notes for the SELFCOMPACT paper, experiments, and the AgentScope implementation PR. |
49+
4350
## 🚀 Quick Start
4451

4552
### Installation

README_ZH.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,6 @@
2020

2121
FlowLLM 是一个配置驱动的 LLM 应用框架,用 **Service、Job、Step、Component** 组织工作流、服务入口和长期组件。
2222

23-
## 🧠 FlowLLM 开发 Skill
24-
25-
FlowLLM 提供面向编程 Agent 的开发 Skill,覆盖框架约定、仓库地图、扩展点、测试流程和 review checklist。
26-
27-
修改或扩展代码库时从这里开始:[FlowLLM 开发 Skill](skills/flowllm_dev/SKILL.md)
28-
2923
## ✨ 核心特性
3024

3125
- **配置驱动**:默认从 `flowllm/config/default.yaml` 启动,支持配置文件和 dot notation 覆盖。
@@ -37,6 +31,19 @@ FlowLLM 提供面向编程 Agent 的开发 Skill,覆盖框架约定、仓库
3731
<img src="docs/figure/flowllm-architecture.svg" alt="FlowLLM Architecture" width="92%">
3832
</p>
3933

34+
## 🧠 FlowLLM 开发 Skill
35+
36+
FlowLLM 提供面向编程 Agent 的开发 Skill,覆盖框架约定、仓库地图、扩展点、测试流程和 review checklist。
37+
38+
修改或扩展代码库时从这里开始:[FlowLLM 开发 Skill](skills/flowllm_dev/SKILL.md)
39+
40+
## 📝 技术笔记
41+
42+
| 笔记 | 说明 |
43+
|---------------------------------------------------------------------------|----------------------------------------------|
44+
| [上下文管理设计](note/context_management_design.md) | Agent 短期上下文管理设计,包括历史压缩和工具结果截断。 |
45+
| [SELFCOMPACT 论文与 AgentScope PR #1938](note/self_compact_agentscope_pr.md) | SELFCOMPACT 论文、实验结果和 AgentScope 实现 PR 的技术解读。 |
46+
4047
## 🚀 快速开始
4148

4249
### 安装

0 commit comments

Comments
 (0)