Skip to content

docs(cli): fix incorrect config filename in hooks documentation#1

Closed
hellomypastor wants to merge 1 commit intomainfrom
fix/docs-hooks-config-filename
Closed

docs(cli): fix incorrect config filename in hooks documentation#1
hellomypastor wants to merge 1 commit intomainfrom
fix/docs-hooks-config-filename

Conversation

@hellomypastor
Copy link
Copy Markdown
Owner

Summary

  • Problem: docs/cli/hooks.md and docs/zh-CN/cli/hooks.md reference ~/.openclaw/config.json as the config file path.
  • Why it matters: The actual config file is ~/.openclaw/openclaw.json. Users following the docs would look for the wrong file.
  • What changed: Corrected the config filename from config.json to openclaw.json in both English and Chinese hooks docs.
  • What did NOT change (scope boundary): No code, logic, or other documentation changes.

Change Type (select all)

  • Bug fix
  • Feature
  • Refactor required for the fix
  • Docs
  • Security hardening
  • Chore/infra

Scope (select all touched areas)

  • Gateway / orchestration
  • Skills / tool execution
  • Auth / tokens
  • Memory / storage
  • Integrations
  • API / contracts
  • UI / DX
  • CI/CD / infra

Linked Issue/PR

  • This PR fixes a bug or regression

Root Cause / Regression History (if applicable)

N/A

Regression Test Plan (if applicable)

N/A

User-visible / Behavior Changes

Docs now point to the correct config file path (~/.openclaw/openclaw.json).

Diagram (if applicable)

N/A

Security Impact (required)

  • New permissions/capabilities? No
  • Secrets/tokens handling changed? No
  • New/changed network calls? No
  • Command/tool execution surface changed? No
  • Data access scope changed? No

Repro + Verification

Environment

  • OS: macOS (Darwin 25.3.0)

Steps

  1. Open docs/cli/hooks.md line 128
  2. Observe it references ~/.openclaw/config.json
  3. Cross-check with source code (src/config/io.owner-display-secret.test.ts, src/wizard/setup.test.ts) — actual file is openclaw.json

Expected

  • Docs reference ~/.openclaw/openclaw.json

Actual

  • Before: ~/.openclaw/config.json
  • After: ~/.openclaw/openclaw.json

Evidence

  • Verified against test fixtures (src/config/io.owner-display-secret.test.ts:38, src/wizard/setup.test.ts:92) confirming openclaw.json is the correct filename

Human Verification (required)

  • Verified scenarios: grep'd codebase for openclaw.json — consistently used as the config filename
  • Edge cases checked: both English and Chinese docs updated
  • What you did not verify: other docs that might reference the config path (grep showed only these two files use config.json)

Review Conversations

  • I replied to or resolved every bot review conversation I addressed in this PR.
  • I left unresolved only the conversations that still need reviewer or maintainer judgment.

Compatibility / Migration

  • Backward compatible? Yes
  • Config/env changes? No
  • Migration needed? No

Risks and Mitigations

None

The hooks enable command referenced `~/.openclaw/config.json` but the
actual config file is `~/.openclaw/openclaw.json`.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant