← Back to PRs

#19560: docs: refactor agent workspace default location & bootstrap configuration s…

by ashinkuniyil open 2026-02-17 23:29 View on GitHub →
docs size: XS
…tructure in documentation ## Summary Describe the problem and fix in 2–5 bullets: - Problem: - Why it matters: - What changed: - What did NOT change (scope boundary): ## Change Type (select all) - [ ] Bug fix - [ ] Feature - [ ] Refactor - [x] 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 - Closes # - Related # ## User-visible / Behavior Changes List user-visible changes (including defaults/config). If none, write `None`. ## Security Impact (required) - New permissions/capabilities? (`Yes/No`) - Secrets/tokens handling changed? (`Yes/No`) - New/changed network calls? (`Yes/No`) - Command/tool execution surface changed? (`Yes/No`) - Data access scope changed? (`Yes/No`) - If any `Yes`, explain risk + mitigation: ## Repro + Verification ### Environment - OS: - Runtime/container: - Model/provider: - Integration/channel (if any): - Relevant config (redacted): ### Steps 1. 2. 3. ### Expected - ### Actual - ## Evidence Attach at least one: - [ ] Failing test/log before + passing after - [ ] Trace/log snippets - [ ] Screenshot/recording - [ ] Perf numbers (if relevant) ## Human Verification (required) What you personally verified (not just CI), and how: - Verified scenarios: - Edge cases checked: - What you did **not** verify: ## Compatibility / Migration - Backward compatible? (`Yes/No`) - Config/env changes? (`Yes/No`) - Migration needed? (`Yes/No`) - If yes, exact upgrade steps: ## Failure Recovery (if this breaks) - How to disable/revert this change quickly: - Files/config to restore: - Known bad symptoms reviewers should watch for: ## Risks and Mitigations List only real risks for this PR. Add/remove entries as needed. If none, write `None`. - Risk: - Mitigation: <!-- greptile_comment --> <h3>Greptile Summary</h3> This PR updates `docs/concepts/agent-workspace.md` to correct the JSON5 config examples from the legacy `agent` key to the current `agents.defaults` nesting structure. The structural change is correct and matches the actual config schema (`AgentDefaultsSchema` in `src/config/zod-schema.agent-defaults.ts`). - **Correct structural refactor**: `agent: { workspace, skipBootstrap }` → `agents: { defaults: { workspace, skipBootstrap } }` aligns with the codebase schema - **Policy violation**: The workspace example value was changed from the generic `~/.openclaw/workspace` to a personal path (`/Users/ashinkuniyil/Desktop/AgentX OS`), violating the repo's AGENTS.md rule: _"Docs content must be generic: no personal device names/hostnames/paths"_ - The `skipBootstrap` example formatting was expanded to multi-line for readability, which is a minor style improvement <h3>Confidence Score: 3/5</h3> - Docs-only change that is structurally correct but contains a personal path that violates repository documentation policy. - The config key refactoring is valid and matches the actual schema, but the hardcoded personal path in the example violates the repository's explicit policy against personal device names/paths in documentation. This should be fixed before merging. - `docs/concepts/agent-workspace.md` — the workspace example path must be replaced with a generic placeholder. <sub>Last reviewed commit: 707a23b</sub> <!-- greptile_other_comments_section --> <sub>(2/5) Greptile learns from your feedback when you react with thumbs up/down!</sub> **Context used:** - Context from `dashboard` - AGENTS.md ([source](https://app.greptile.com/review/custom-context?memory=0d0c8278-ef8e-4d6c-ab21-f5527e322f13)) <!-- /greptile_comment -->

Most Similar PRs