Skip to content

docs(cli): new page cli/config.md — netclaw config dashboard reference (post-netclaw-dev/netclaw#1368) #59

Description

@Aaronontheweb

Context

Create new page src/content/docs/cli/config.md documenting the reentrant netclaw config dashboard introduced by netclaw-dev/netclaw#1368. This command is entirely undocumented today.

Current

Page does not exist. The entire netclaw config surface is undocumented.

Should become

A complete reference for the netclaw config menu-driven dashboard, covering:

  • Entry point — run netclaw config at any time (reentrant; daemon need not be running)
  • Live status dashboard — shows current state across all 8+ areas before entering a sub-menu
  • Per-area editors (one section each):
    • Security & Access (posture, allowed channels — links to Channels section)
    • Channels — resolve-before-add prominently explained: enter comma-separated names or IDs → resolved to canonical IDs before save; unresolvable names rejected; stored ACL holds canonical IDs; display names shown dynamically. Breaking-change callout: raw display names in AllowedChannelIds no longer match after upgrade from pre-0.24.0 → messages dropped; re-enter via config to fix.
    • Search — backend selection + reachability probe (SearXNG URL probed, save blocked on failure — the #1151 fix)
    • Skill Sources — auto-detection of well-known dirs; custom path entry
    • Telemetry & Alerting — multi-webhook list editor (add / remove / test)
    • Inbound Webhooks — enable/disable + route management
    • Browser Automation — toggle + endpoint
    • Workspaces Directory — path config
  • Autosave-on-complete behavior
  • Routed handoffs — certain areas (netclaw provider, netclaw model) open sub-commands; note when and link out
  • Sidebar placement: immediately after cli/init.md

Screenshots or tapes needed

config-dashboard, config-channels-menu, config-channels-add, config-channels-resolve (resolution succeeding and/or rejecting a bad name), config-search, config-telemetry, config-inbound-webhooks, config-exposure, config-skills, config-browser, config-workspaces.

Seed state for captures: Slack connected, Brave search, Team posture, 2 notification webhooks, 1 inbound route, local exposure, 2 external skill sources.

All captures gated on stable release + sub-issue #13. Leave <!-- capture after release --> placeholders until then.

Acceptance criteria

  • Page exists at src/content/docs/cli/config.md and appears in sidebar nav (after cli/init.md)
  • All 8 areas documented with per-area behavior
  • Channels resolve-before-add explained with breaking-change callout for pre-0.24.0 configs
  • Autosave-on-complete behavior documented
  • Routed handoffs (netclaw provider, netclaw model) noted
  • Page linked from cli/init.md ("After init" callout) and all channel pages
  • <img> tags filled once captures available (sub-issue Update exposure/pairing docs and homepage hero copy #13)

Dependencies

Part of #55

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions