docs: overhaul docs IA and multilingual navigation
This commit is contained in:
parent
5e800c38f1
commit
93e5383cb2
40 changed files with 2495 additions and 198 deletions
72
docs/config-reference.md
Normal file
72
docs/config-reference.md
Normal file
|
|
@ -0,0 +1,72 @@
|
|||
# ZeroClaw Config Reference (Operator-Oriented)
|
||||
|
||||
This is a high-signal reference for common config sections and defaults.
|
||||
|
||||
Last verified: **February 18, 2026**.
|
||||
|
||||
Config file path:
|
||||
|
||||
- `~/.zeroclaw/config.toml`
|
||||
|
||||
## Core Keys
|
||||
|
||||
| Key | Default | Notes |
|
||||
|---|---|---|
|
||||
| `default_provider` | `openrouter` | provider ID or alias |
|
||||
| `default_model` | `anthropic/claude-sonnet-4` | model routed through selected provider |
|
||||
| `default_temperature` | `0.7` | model temperature |
|
||||
|
||||
## `[gateway]`
|
||||
|
||||
| Key | Default | Purpose |
|
||||
|---|---|---|
|
||||
| `host` | `127.0.0.1` | bind address |
|
||||
| `port` | `3000` | gateway listen port |
|
||||
| `require_pairing` | `true` | require pairing before bearer auth |
|
||||
| `allow_public_bind` | `false` | block accidental public exposure |
|
||||
|
||||
## `[memory]`
|
||||
|
||||
| Key | Default | Purpose |
|
||||
|---|---|---|
|
||||
| `backend` | `sqlite` | `sqlite`, `lucid`, `markdown`, `none` |
|
||||
| `auto_save` | `true` | automatic persistence |
|
||||
| `embedding_provider` | `none` | `none`, `openai`, or custom endpoint |
|
||||
| `vector_weight` | `0.7` | hybrid ranking vector weight |
|
||||
| `keyword_weight` | `0.3` | hybrid ranking keyword weight |
|
||||
|
||||
## `[channels_config]`
|
||||
|
||||
Top-level channel options are configured under `channels_config`.
|
||||
|
||||
Examples:
|
||||
|
||||
- `[channels_config.telegram]`
|
||||
- `[channels_config.discord]`
|
||||
- `[channels_config.whatsapp]`
|
||||
- `[channels_config.email]`
|
||||
|
||||
See detailed channel matrix and allowlist behavior in [channels-reference.md](channels-reference.md).
|
||||
|
||||
## Security-Relevant Defaults
|
||||
|
||||
- deny-by-default channel allowlists (`[]` means deny all)
|
||||
- pairing required on gateway by default
|
||||
- public bind disabled by default
|
||||
|
||||
## Validation Commands
|
||||
|
||||
After editing config:
|
||||
|
||||
```bash
|
||||
zeroclaw status
|
||||
zeroclaw doctor
|
||||
zeroclaw channel doctor
|
||||
```
|
||||
|
||||
## Related Docs
|
||||
|
||||
- [channels-reference.md](channels-reference.md)
|
||||
- [providers-reference.md](providers-reference.md)
|
||||
- [operations-runbook.md](operations-runbook.md)
|
||||
- [troubleshooting.md](troubleshooting.md)
|
||||
Loading…
Add table
Add a link
Reference in a new issue