mirror of
https://github.com/openclaw/openclaw.git
synced 2026-03-12 07:20:45 +00:00
docs: add missing summary/read_when metadata
This commit is contained in:
Peter Steinberger
@@ -1,5 +1,8 @@
|
||||
---
|
||||
summary: "Plan: isolate browser act:evaluate from Playwright queue using CDP, with end-to-end deadlines and safer ref resolution"
|
||||
read_when:
|
||||
- Working on browser `act:evaluate` timeout, abort, or queue blocking issues
|
||||
- Planning CDP based isolation for evaluate execution
|
||||
owner: "openclaw"
|
||||
status: "draft"
|
||||
last_updated: "2026-02-10"
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
---
|
||||
summary: "Harden cron.add input handling, align schemas, and improve cron UI/agent tooling"
|
||||
read_when:
|
||||
- Debugging invalid `cron.add` payloads
|
||||
- Aligning cron schemas across gateway, CLI, and UI
|
||||
owner: "openclaw"
|
||||
status: "complete"
|
||||
last_updated: "2026-01-05"
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
---
|
||||
summary: "Plan: Add OpenResponses /v1/responses endpoint and deprecate chat completions cleanly"
|
||||
read_when:
|
||||
- Designing or implementing `/v1/responses` gateway support
|
||||
- Planning migration from Chat Completions compatibility
|
||||
owner: "openclaw"
|
||||
status: "draft"
|
||||
last_updated: "2026-01-19"
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
---
|
||||
summary: "Production plan for reliable interactive process supervision (PTY + non-PTY) with explicit ownership, unified lifecycle, and deterministic cleanup"
|
||||
read_when:
|
||||
- Working on exec/process lifecycle ownership and cleanup
|
||||
- Debugging PTY and non-PTY supervision behavior
|
||||
owner: "openclaw"
|
||||
status: "in-progress"
|
||||
last_updated: "2026-02-15"
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
---
|
||||
summary: "Channel agnostic session binding architecture and iteration 1 delivery scope"
|
||||
read_when:
|
||||
- Refactoring channel-agnostic session routing and bindings
|
||||
- Investigating duplicate, stale, or missing session delivery across channels
|
||||
owner: "onutc"
|
||||
status: "in-progress"
|
||||
last_updated: "2026-02-21"
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
---
|
||||
title: "Configuration Reference"
|
||||
description: "Complete field-by-field reference for ~/.openclaw/openclaw.json"
|
||||
summary: "Complete reference for every OpenClaw config key, defaults, and channel settings"
|
||||
read_when:
|
||||
- You need exact field-level config semantics or defaults
|
||||
- You are validating channel, model, gateway, or tool config blocks
|
||||
---
|
||||
|
||||
# Configuration Reference
|
||||
|
||||
@@ -1,5 +1,8 @@
|
||||
---
|
||||
summary: "Frequently asked questions about OpenClaw setup, configuration, and usage"
|
||||
read_when:
|
||||
- Answering common setup, install, onboarding, or runtime support questions
|
||||
- Triaging user-reported issues before deeper debugging
|
||||
title: "FAQ"
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
---
|
||||
title: Fly.io
|
||||
description: Deploy OpenClaw on Fly.io
|
||||
summary: "Step-by-step Fly.io deployment for OpenClaw with persistent storage and HTTPS"
|
||||
read_when:
|
||||
- Deploying OpenClaw on Fly.io
|
||||
- Setting up Fly volumes, secrets, and first-run config
|
||||
---
|
||||
|
||||
# Fly.io Deployment
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
---
|
||||
title: "Pi Development Workflow"
|
||||
summary: "Developer workflow for Pi integration: build, test, and live validation"
|
||||
read_when:
|
||||
- Working on Pi integration code or tests
|
||||
- Running Pi-specific lint, typecheck, and live test flows
|
||||
---
|
||||
|
||||
# Pi Development Workflow
|
||||
|
||||
@@ -1,5 +1,9 @@
|
||||
---
|
||||
title: "Pi Integration Architecture"
|
||||
summary: "Architecture of OpenClaw's embedded Pi agent integration and session lifecycle"
|
||||
read_when:
|
||||
- Understanding Pi SDK integration design in OpenClaw
|
||||
- Modifying agent session lifecycle, tooling, or provider wiring for Pi
|
||||
---
|
||||
|
||||
# Pi Integration Architecture
|
||||
|
||||
@@ -1,6 +1,10 @@
|
||||
---
|
||||
title: Outbound Session Mirroring Refactor (Issue #1520)
|
||||
description: Track outbound session mirroring refactor notes, decisions, tests, and open items.
|
||||
summary: "Refactor notes for mirroring outbound sends into target channel sessions"
|
||||
read_when:
|
||||
- Working on outbound transcript/session mirroring behavior
|
||||
- Debugging sessionKey derivation for send/message tool paths
|
||||
---
|
||||
|
||||
# Outbound Session Mirroring Refactor (Issue #1520)
|
||||
|
||||
@@ -1,6 +1,9 @@
|
||||
---
|
||||
title: Formal Verification (Security Models)
|
||||
summary: Machine-checked security models for OpenClaw’s highest-risk paths.
|
||||
read_when:
|
||||
- Reviewing formal security model guarantees or limits
|
||||
- Reproducing or updating TLA+/TLC security model checks
|
||||
permalink: /security/formal-verification/
|
||||
---
|
||||
|
||||
|
||||
@@ -2,6 +2,9 @@
|
||||
title: "Showcase"
|
||||
description: "Real-world OpenClaw projects from the community"
|
||||
summary: "Community-built projects and integrations powered by OpenClaw"
|
||||
read_when:
|
||||
- Looking for real OpenClaw usage examples
|
||||
- Updating community project highlights
|
||||
---
|
||||
|
||||
# Showcase
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: "Tool-loop detection"
|
||||
description: "Configure optional guardrails for preventing repetitive or stalled tool-call loops"
|
||||
summary: "How to enable and tune guardrails that detect repetitive tool-call loops"
|
||||
read_when:
|
||||
- A user reports agents getting stuck repeating tool calls
|
||||
- You need to tune repetitive-call protection
|
||||
|
||||
Reference in New Issue
Block a user