Document config-example.toml as the canonical deployed config

Makes it clear that the example config is meant to be symlinked into $XDG_CONFIG_HOME/agent-sandbox/ so it stays in sync with the repo.
2026-04-22 22:43:46 +02:00
parent 972747a891
commit 6933deb441
2 changed files with 9 additions and 1 deletions
@@ -1,5 +1,9 @@
 # Agent guidelines for agent-sandbox

+## Deployed config
+
+`config-example.toml` in the repo root is the canonical config file. It is symlinked into `$XDG_CONFIG_HOME/agent-sandbox/config.toml` on the host. When editing it, remember that changes take effect immediately for all sandbox invocations.
+
 ## Build and test

 - `cargo fmt` and `cargo clippy` must pass before every commit.