From daef8f8094a70a9c8a144312001965f1b34ff2e7 Mon Sep 17 00:00:00 2001 From: Chummy Date: Wed, 18 Feb 2026 21:06:01 +0800 Subject: [PATCH] docs(docs): align navigation inventory and model examples for #774 --- .env.example | 2 +- docs/README.ja.md | 7 +++++++ docs/README.md | 6 ++++++ docs/README.ru.md | 7 +++++++ docs/README.zh-CN.md | 7 +++++++ docs/SUMMARY.md | 8 +++++++- docs/docs-inventory.md | 7 ++++++- docs/hardware/README.md | 5 ++++- docs/langgraph-integration.md | 2 +- docs/reference/README.md | 12 ++++++++++-- 10 files changed, 56 insertions(+), 7 deletions(-) diff --git a/.env.example b/.env.example index 327bdc6..42a0b37 100644 --- a/.env.example +++ b/.env.example @@ -15,7 +15,7 @@ API_KEY=your-api-key-here # Default provider/model (can be overridden by CLI flags) PROVIDER=openrouter # ZEROCLAW_PROVIDER=openrouter -# ZEROCLAW_MODEL=anthropic/claude-sonnet-4-20250514 +# ZEROCLAW_MODEL=anthropic/claude-sonnet-4-6 # ZEROCLAW_TEMPERATURE=0.7 # Workspace directory override diff --git a/docs/README.ja.md b/docs/README.ja.md index aa418b2..5252c98 100644 --- a/docs/README.ja.md +++ b/docs/README.ja.md @@ -14,6 +14,9 @@ | ワンコマンドで導入したい | [one-click-bootstrap.md](one-click-bootstrap.md) | | コマンドを用途別に確認したい | [commands-reference.md](commands-reference.md) | | 設定キーと既定値を確認したい | [config-reference.md](config-reference.md) | +| カスタム Provider / endpoint を追加したい | [custom-providers.md](custom-providers.md) | +| Z.AI / GLM Provider を設定したい | [zai-glm-setup.md](zai-glm-setup.md) | +| LangGraph ツール連携を使いたい | [langgraph-integration.md](langgraph-integration.md) | | 日常運用（runbook）を確認したい | [operations-runbook.md](operations-runbook.md) | | インストール/実行トラブルを解決したい | [troubleshooting.md](troubleshooting.md) | | 統合 TOC から探したい | [SUMMARY.md](SUMMARY.md) | @@ -48,6 +51,9 @@ - [providers-reference.md](providers-reference.md) - [channels-reference.md](channels-reference.md) - [config-reference.md](config-reference.md) +- [custom-providers.md](custom-providers.md) +- [zai-glm-setup.md](zai-glm-setup.md) +- [langgraph-integration.md](langgraph-integration.md) - [operations-runbook.md](operations-runbook.md) - [troubleshooting.md](troubleshooting.md) @@ -65,6 +71,7 @@ - [security/README.md](security/README.md) - [agnostic-security.md](agnostic-security.md) +- [frictionless-security.md](frictionless-security.md) - [sandboxing.md](sandboxing.md) - [resource-limits.md](resource-limits.md) - [audit-logging.md](audit-logging.md) diff --git a/docs/README.md b/docs/README.md index 92d7b09..cf9e807 100644 --- a/docs/README.md +++ b/docs/README.md @@ -14,6 +14,9 @@ Localized hubs: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · | Bootstrap in one command | [one-click-bootstrap.md](one-click-bootstrap.md) | | Find commands by task | [commands-reference.md](commands-reference.md) | | Check config defaults and keys quickly | [config-reference.md](config-reference.md) | +| Configure custom providers/endpoints | [custom-providers.md](custom-providers.md) | +| Configure Z.AI / GLM provider | [zai-glm-setup.md](zai-glm-setup.md) | +| Use LangGraph integration patterns | [langgraph-integration.md](langgraph-integration.md) | | Operate runtime (day-2 runbook) | [operations-runbook.md](operations-runbook.md) | | Troubleshoot install/runtime/channel issues | [troubleshooting.md](troubleshooting.md) | | Run Matrix encrypted-room setup and diagnostics | [matrix-e2ee-guide.md](matrix-e2ee-guide.md) | @@ -50,6 +53,9 @@ Localized hubs: [简体中文](README.zh-CN.md) · [日本語](README.ja.md) · - [channels-reference.md](channels-reference.md) — channel capabilities and setup paths - [matrix-e2ee-guide.md](matrix-e2ee-guide.md) — Matrix encrypted-room (E2EE) setup and no-response diagnostics - [config-reference.md](config-reference.md) — high-signal config keys and secure defaults +- [custom-providers.md](custom-providers.md) — custom provider/base URL integration templates +- [zai-glm-setup.md](zai-glm-setup.md) — Z.AI/GLM setup and endpoint matrix +- [langgraph-integration.md](langgraph-integration.md) — fallback integration for model/tool-calling edge cases - [operations-runbook.md](operations-runbook.md) — day-2 runtime operations and rollback flow - [troubleshooting.md](troubleshooting.md) — common failure signatures and recovery steps diff --git a/docs/README.ru.md b/docs/README.ru.md index d1b0f10..fbfbc85 100644 --- a/docs/README.ru.md +++ b/docs/README.ru.md @@ -14,6 +14,9 @@ | Установить одной командой | [one-click-bootstrap.md](one-click-bootstrap.md) | | Найти команды по задаче | [commands-reference.md](commands-reference.md) | | Проверить ключи конфигурации и дефолты | [config-reference.md](config-reference.md) | +| Подключить кастомный provider / endpoint | [custom-providers.md](custom-providers.md) | +| Настроить provider Z.AI / GLM | [zai-glm-setup.md](zai-glm-setup.md) | +| Использовать интеграцию LangGraph | [langgraph-integration.md](langgraph-integration.md) | | Операционный runbook (day-2) | [operations-runbook.md](operations-runbook.md) | | Быстро устранить типовые проблемы | [troubleshooting.md](troubleshooting.md) | | Открыть общий TOC docs | [SUMMARY.md](SUMMARY.md) | @@ -48,6 +51,9 @@ - [providers-reference.md](providers-reference.md) - [channels-reference.md](channels-reference.md) - [config-reference.md](config-reference.md) +- [custom-providers.md](custom-providers.md) +- [zai-glm-setup.md](zai-glm-setup.md) +- [langgraph-integration.md](langgraph-integration.md) - [operations-runbook.md](operations-runbook.md) - [troubleshooting.md](troubleshooting.md) @@ -65,6 +71,7 @@ - [security/README.md](security/README.md) - [agnostic-security.md](agnostic-security.md) +- [frictionless-security.md](frictionless-security.md) - [sandboxing.md](sandboxing.md) - [resource-limits.md](resource-limits.md) - [audit-logging.md](audit-logging.md) diff --git a/docs/README.zh-CN.md b/docs/README.zh-CN.md index e45284d..a07ecb7 100644 --- a/docs/README.zh-CN.md +++ b/docs/README.zh-CN.md @@ -14,6 +14,9 @@ | 一键安装与初始化 | [one-click-bootstrap.md](one-click-bootstrap.md) | | 按任务找命令 | [commands-reference.md](commands-reference.md) | | 快速查看配置默认值与关键项 | [config-reference.md](config-reference.md) | +| 接入自定义 Provider / endpoint | [custom-providers.md](custom-providers.md) | +| 配置 Z.AI / GLM Provider | [zai-glm-setup.md](zai-glm-setup.md) | +| 使用 LangGraph 工具调用集成 | [langgraph-integration.md](langgraph-integration.md) | | 进行日常运维（runbook） | [operations-runbook.md](operations-runbook.md) | | 快速排查安装/运行问题 | [troubleshooting.md](troubleshooting.md) | | 统一目录导航 | [SUMMARY.md](SUMMARY.md) | @@ -48,6 +51,9 @@ - [providers-reference.md](providers-reference.md) - [channels-reference.md](channels-reference.md) - [config-reference.md](config-reference.md) +- [custom-providers.md](custom-providers.md) +- [zai-glm-setup.md](zai-glm-setup.md) +- [langgraph-integration.md](langgraph-integration.md) - [operations-runbook.md](operations-runbook.md) - [troubleshooting.md](troubleshooting.md) @@ -65,6 +71,7 @@ - [security/README.md](security/README.md) - [agnostic-security.md](agnostic-security.md) +- [frictionless-security.md](frictionless-security.md) - [sandboxing.md](sandboxing.md) - [resource-limits.md](resource-limits.md) - [audit-logging.md](audit-logging.md) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 4cc030c..10ce8ae 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -22,13 +22,16 @@ Last refreshed: **February 18, 2026**. - [getting-started/README.md](getting-started/README.md) - [one-click-bootstrap.md](one-click-bootstrap.md) -### 2) Command/Config References +### 2) Command/Config References & Integrations - [reference/README.md](reference/README.md) - [commands-reference.md](commands-reference.md) - [providers-reference.md](providers-reference.md) - [channels-reference.md](channels-reference.md) - [config-reference.md](config-reference.md) +- [custom-providers.md](custom-providers.md) +- [zai-glm-setup.md](zai-glm-setup.md) +- [langgraph-integration.md](langgraph-integration.md) ### 3) Operations & Deployment @@ -55,6 +58,9 @@ Last refreshed: **February 18, 2026**. - [adding-boards-and-tools.md](adding-boards-and-tools.md) - [nucleo-setup.md](nucleo-setup.md) - [arduino-uno-q-setup.md](arduino-uno-q-setup.md) +- [datasheets/nucleo-f401re.md](datasheets/nucleo-f401re.md) +- [datasheets/arduino-uno.md](datasheets/arduino-uno.md) +- [datasheets/esp32.md](datasheets/esp32.md) ### 6) Contribution & CI diff --git a/docs/docs-inventory.md b/docs/docs-inventory.md index 99027eb..f69bf9a 100644 --- a/docs/docs-inventory.md +++ b/docs/docs-inventory.md @@ -46,6 +46,9 @@ Last reviewed: **February 18, 2026**. | `docs/providers-reference.md` | Current Reference | users/operators | | `docs/channels-reference.md` | Current Reference | users/operators | | `docs/config-reference.md` | Current Reference | operators | +| `docs/custom-providers.md` | Current Integration Guide | integration developers | +| `docs/zai-glm-setup.md` | Current Provider Setup Guide | users/operators | +| `docs/langgraph-integration.md` | Current Integration Guide | integration developers | | `docs/operations-runbook.md` | Current Guide | operators | | `docs/troubleshooting.md` | Current Guide | users/operators | | `docs/network-deployment.md` | Current Guide | operators | @@ -54,7 +57,9 @@ Last reviewed: **February 18, 2026**. | `docs/arduino-uno-q-setup.md` | Current Guide | hardware builders | | `docs/nucleo-setup.md` | Current Guide | hardware builders | | `docs/hardware-peripherals-design.md` | Current Design Spec | hardware contributors | -| `docs/langgraph-integration.md` | Current Integration Guide | integration developers | +| `docs/datasheets/nucleo-f401re.md` | Current Hardware Reference | hardware builders | +| `docs/datasheets/arduino-uno.md` | Current Hardware Reference | hardware builders | +| `docs/datasheets/esp32.md` | Current Hardware Reference | hardware builders | ## Policy / Process Docs diff --git a/docs/hardware/README.md b/docs/hardware/README.md index 6db982e..e2158ec 100644 --- a/docs/hardware/README.md +++ b/docs/hardware/README.md @@ -11,4 +11,7 @@ For board integration, firmware flow, and peripheral architecture. ## Datasheets -- Board/chip datasheets: [../datasheets](../datasheets) +- Datasheet index: [../datasheets](../datasheets) +- STM32 Nucleo-F401RE: [../datasheets/nucleo-f401re.md](../datasheets/nucleo-f401re.md) +- Arduino Uno: [../datasheets/arduino-uno.md](../datasheets/arduino-uno.md) +- ESP32: [../datasheets/esp32.md](../datasheets/esp32.md) diff --git a/docs/langgraph-integration.md b/docs/langgraph-integration.md index a7e64f9..83ddc9c 100644 --- a/docs/langgraph-integration.md +++ b/docs/langgraph-integration.md @@ -132,7 +132,7 @@ agent = create_agent( ```python agent = create_agent( - model="anthropic/claude-3.5-sonnet", + model="anthropic/claude-sonnet-4-6", api_key="your-openrouter-key", base_url="https://openrouter.ai/api/v1" ) diff --git a/docs/reference/README.md b/docs/reference/README.md index 391d624..3bab9bc 100644 --- a/docs/reference/README.md +++ b/docs/reference/README.md @@ -1,6 +1,6 @@ # Reference Catalogs -Structured reference index for commands, providers, channels, and config. +Structured reference index for commands, providers, channels, config, and integration guides. ## Core References @@ -9,6 +9,14 @@ Structured reference index for commands, providers, channels, and config. - Channel setup + allowlists: [../channels-reference.md](../channels-reference.md) - Config defaults and keys: [../config-reference.md](../config-reference.md) +## Provider & Integration Extensions + +- Custom provider endpoints: [../custom-providers.md](../custom-providers.md) +- Z.AI / GLM provider onboarding: [../zai-glm-setup.md](../zai-glm-setup.md) +- LangGraph-based integration patterns: [../langgraph-integration.md](../langgraph-integration.md) + ## Usage -Use this collection when you need precise CLI/config details rather than step-by-step tutorials. +Use this collection when you need precise CLI/config details or provider integration patterns rather than step-by-step tutorials. + +When adding a new reference/integration doc, make sure it is linked in both [../SUMMARY.md](../SUMMARY.md) and [../docs-inventory.md](../docs-inventory.md).