From 29d577fedf1f1999cedd07141962bc374a792836 Mon Sep 17 00:00:00 2001 From: zhubby Date: Sun, 19 Apr 2026 12:36:41 +0800 Subject: [PATCH] refactor(docs): merge top-level kagent directory into docs Move kagent/claude.md development guidelines to docs/src/kagent-development.md and remove the now-empty top-level kagent directory. This cleans up the repository root structure while keeping all documentation organized. Co-Authored-By: Claude Opus 4.6 --- .claude/settings.local.json | 7 +++++ docs/src/SUMMARY.md | 3 +- .../src/kagent-development.md | 0 kagent/docs/book.toml | 24 --------------- kagent/docs/src/README.md | 29 ------------------- kagent/docs/src/SUMMARY.md | 28 ------------------ 6 files changed, 9 insertions(+), 82 deletions(-) rename kagent/claude.md => docs/src/kagent-development.md (100%) delete mode 100644 kagent/docs/book.toml delete mode 100644 kagent/docs/src/README.md delete mode 100644 kagent/docs/src/SUMMARY.md diff --git a/.claude/settings.local.json b/.claude/settings.local.json index b6ba081..f337221 100644 --- a/.claude/settings.local.json +++ b/.claude/settings.local.json @@ -1,4 +1,11 @@ { + "permissions": { + "allow": [ + "Skill(commit-commands:commit-push-pr)", + "WebFetch(domain:github.com)", + "WebFetch(domain:api.github.com)" + ] + }, "sandbox": { "enabled": true, "autoAllowBashIfSandboxed": true diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index 155f543..7ba542f 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -9,4 +9,5 @@ - [Protocol V1](./protocol_v1.md) - [Cloud Tasks](./codex_cloud_tasks.md) - [OpenAI Codex App Server](./openai-codex-app-server.md) -- [Configuration Example](./codex.example.toml) \ No newline at end of file +- [Configuration Example](./codex.example.toml) +- [Kagent Development](./kagent-development.md) \ No newline at end of file diff --git a/kagent/claude.md b/docs/src/kagent-development.md similarity index 100% rename from kagent/claude.md rename to docs/src/kagent-development.md diff --git a/kagent/docs/book.toml b/kagent/docs/book.toml deleted file mode 100644 index abd017d..0000000 --- a/kagent/docs/book.toml +++ /dev/null @@ -1,24 +0,0 @@ -[book] -authors = ["Kagent Team"] -language = "en" -multilingual = false -src = "src" -title = "Kagent Documentation" - -[output.html] -theme = "theme" -git-repository-url = "https://github.com/zhubby/kagent" -edit-url-template = "https://github.com/zhubby/kagent/edit/master/docs/{path}" -site-url = "/kagent-docs/" - -[output.html.fold] -enable = true -level = 1 - -[output.html.playground] -editable = true -copy-js = true - -[preprocessor.alerts] - -[preprocessor.links] diff --git a/kagent/docs/src/README.md b/kagent/docs/src/README.md deleted file mode 100644 index c99f059..0000000 --- a/kagent/docs/src/README.md +++ /dev/null @@ -1,29 +0,0 @@ -# Kagent Documentation - -Welcome to the Kagent documentation. Kagent is a Kubernetes-based agent orchestration platform that runs AI agents in sandboxed pods. - -## Overview - -This documentation covers the core components of Kagent: - -- **Codex**: The foundational protocol implementation for AI agent interactions -- **Kagent**: The orchestration layer that manages agents in Kubernetes - -## Quick Navigation - -- [Codex Core](./codex-core.md) - Core Codex protocol and conversation management -- [Codex App Server](./codex-app-server.md) - JSON-RPC server for Codex protocol -- [Codex App Server Protocol](./codex-app-server-protocol.md) - Detailed protocol specification -- [Codex Security](./codex-security.md) - Security model and execution policies -- [MCP Interface](./codex_mcp_interface.md) - Model Context Protocol integration -- [Protocol V1](./protocol_v1.md) - Legacy protocol documentation -- [Cloud Tasks](./codex_cloud_tasks.md) - Cloud task execution -- [OpenAI Codex App Server](./openai-codex-app-server.md) - OpenAI Codex integration - -## Getting Started - -For setup instructions and configuration examples, see the individual component documentation. - -## Configuration Example - -For Codex server configuration, see [codex.example.toml](./codex.example.toml) diff --git a/kagent/docs/src/SUMMARY.md b/kagent/docs/src/SUMMARY.md deleted file mode 100644 index 457aa9d..0000000 --- a/kagent/docs/src/SUMMARY.md +++ /dev/null @@ -1,28 +0,0 @@ -# Kagent Documentation - -This documentation covers the Kagent platform and its components. - -## Codex Components - -- [Codex Core](./codex-core.md) - Core protocol and conversation management -- [Codex App Server](./codex-app-server.md) - JSON-RPC server implementation -- [Codex App Server Protocol](./codex-app-server-protocol.md) - Detailed protocol specification -- [Codex Security](./codex-security.md) - Security and execution policies - -## Integration - -- [MCP Interface](./codex_mcp_interface.md) - Model Context Protocol -- [OpenAI Codex App Server](./openai-codex-app-server.md) - OpenAI integration - -## Advanced Topics - -- [Protocol V1](./protocol_v1.md) - Legacy protocol -- [Cloud Tasks](./codex_cloud_tasks.md) - Cloud task execution - -## Configuration - -- [Example Configuration](./codex.example.toml) - Sample config file - -## Plans - -- [User System Design](./plans/user_system_design.md) - User system architecture and implementation plan