Skip to content

docs(config): add missing duckduckgo, exec, and qq sections to example config#514

Merged
yinwm merged 1 commit intosipeed:mainfrom
CrisisAlpha:docs/config-example-add-missing-sections
Feb 20, 2026
Merged

docs(config): add missing duckduckgo, exec, and qq sections to example config#514
yinwm merged 1 commit intosipeed:mainfrom
CrisisAlpha:docs/config-example-add-missing-sections

Conversation

@CrisisAlpha
Copy link
Contributor

📝 Description

config.example.json was missing three sections that exist in the Go config structs (pkg/config/config.go) and have defaults in pkg/config/defaults.go:

  1. tools.web.duckduckgo — DuckDuckGo search is enabled by default in defaults.go and requires no API key (it's the only free web search provider). Users who copy the example config as their starting point silently lose web search because this section was omitted entirely.

  2. tools.exec — The ExecConfig struct supports enable_deny_patterns and custom_deny_patterns for security hardening, but the example config didn't surface these options.

  3. channels.qq — QQ was the only channel defined in ChannelsConfig that was missing from the example while all 9 other channels were present.

🗣️ Type of Change

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 📖 Documentation update
  • ⚡ Code refactoring (no functional changes, no api changes)

🤖 AI Code Generation

  • 🤖 Fully AI-generated (100% AI, 0% Human)
  • 🛠️ Mostly AI-generated (AI draft, Human verified/modified)
  • 👨‍💻 Mostly Human-written (Human lead, AI assisted or none)

🔗 Related Issue

Addresses the Documentation & DX goal in ROADMAP.md (Section 5): "Creating clear, user-friendly documentation for both setup and development."

📚 Technical Context (Skip for Docs)

  • Reference URL: pkg/config/defaults.go lines 245-265 (DuckDuckGo default), pkg/config/config.go lines 392-421 (struct definitions)
  • Reasoning: The example config should reflect all configurable sections so users can discover and customize them. The DuckDuckGo gap is especially impactful since it's the only free, no-API-key search option — aligned with PicoClaw's low-cost philosophy.

🧪 Test Environment

  • Hardware: Mac (x86_64)
  • OS: macOS
  • Verification: JSON validated, make fmt && make vet && make test all pass

☑️ Checklist

  • My code/docs follow the style of this project.
  • I have performed a self-review of my own changes.
  • I have updated the documentation accordingly.

Made with Cursor

…e config

config.example.json was missing three sections that exist in the Go
config structs and defaults:

- tools.web.duckduckgo: DuckDuckGo is enabled by default in
  defaults.go and requires no API key (free search provider), but
  users who copy the example config silently lose it since the
  section was omitted.

- tools.exec: The ExecConfig struct supports enable_deny_patterns
  and custom_deny_patterns for security hardening, but users had
  no way to discover these options from the example.

- channels.qq: The QQ channel was the only channel in ChannelsConfig
  missing from the example while all others were present.

Co-authored-by: Cursor <cursoragent@cursor.com>
@yinwm yinwm merged commit 36a8a03 into sipeed:main Feb 20, 2026
4 checks passed
@Orgmar
Copy link
Contributor

Orgmar commented Feb 21, 2026

@CrisisAlpha Great catch on the missing config sections! Especially the DuckDuckGo one being the only free search provider enabled by default, users starting from the example config would have lost web search without knowing. Really helpful fix.

We have the PicoClaw Dev Group on Discord where contributors connect. If you're interested, email support@sipeed.com with the subject [Join PicoClaw Dev Group] CrisisAlpha and we'll send the invite!

hyperwd pushed a commit to hyperwd/picoclaw that referenced this pull request Mar 5, 2026
…d-missing-sections

docs(config): add missing duckduckgo, exec, and qq sections to example config
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.

3 participants