Skip to content

Docs: Several discrepancies between documentation and source code #7928

@gamer-mitsuha

Description

@gamer-mitsuha

Summary

Found several places where documentation doesn't match the actual source code behavior. Collected during a documentation audit.

1. Bootstrap files list incomplete

Location: Workspace/bootstrap docs

Doc says: 6 workspace files are loaded:
AGENTS.md, SOUL.md, TOOLS.md, BOOTSTRAP.md, IDENTITY.md, USER.md

Source shows 8 files (in injection order):

  1. AGENTS.md
  2. SOUL.md
  3. TOOLS.md
  4. IDENTITY.md
  5. USER.md
  6. HEARTBEAT.md ← missing from docs
  7. BOOTSTRAP.md
  8. MEMORY.md (or memory.md) ← missing from docs

Reference: workspace.jsloadWorkspaceBootstrapFiles()

2. Queue modes undocumented

Location: Queue/steering docs

The docs mention basic queue modes but don't document:

  • steer-backlog
  • steer+backlog

These modes exist in the source code and are valid options.

3. Sub-agent timeoutSeconds default unclear

Location: Sub-agent/spawn docs

Doc says: Default timeoutSeconds is 600s.

Source shows: The zod schema only has z.number().int().positive().optional() with no hardcoded default of 600 found in the relevant source files. The actual default may differ or be applied elsewhere.

Environment

  • OpenClaw version: 2026.2.1

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions