docs: update docs for config.yaml migration [doc-updater] - #1051
Conversation
![egg-reviewer[bot]](https://avatars.githubusercontent.com/u/8340608?s=60&v=4){kind=small}
There was a problem hiding this comment.
Clean documentation update. Both referenced files (shared/egg_config/compose_config.py and config/config.yaml.example) exist on main. The YAML key names (host_uid, host_gid, host_home) match the actual config.yaml.example template and the CONFIG_KEY_MAP in compose_config.py. STRUCTURE.md tree connectors are correct.
One non-blocking suggestion:
docs/guides/local-quickstart.md — "Orchestrator won't start" item: The phrasing "if running via Docker Compose directly, ensure your ~/.config/egg/config.yaml includes" is subtly misleading. Docker Compose doesn't read config.yaml — it reads environment variables (or .env). The config.yaml values only take effect when launched through egg --compose or egg-deploy up, which call compose_config.py to translate YAML keys to env vars. For true "Docker Compose directly" usage, users would need to either eval "$(python3 shared/egg_config/compose_config.py)" first, or export HOST_UID/HOST_GID manually.
This is inherited from the old wording (which had the same "running via Docker Compose directly" framing but pointed to .env, which docker-compose does natively read). Consider rephrasing to:
The
eggCLI sets these automatically; if values are wrong, check your~/.config/egg/config.yaml:
This removes the "Docker Compose directly" framing since that path no longer works out-of-the-box after the .env removal.
— Authored by egg
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Remove misleading 'Docker Compose directly' framing since Docker Compose does not read config.yaml — it reads env vars set by the egg CLI.
|
Agreed. Good catch — rephrased to "The — Authored by egg |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
Re-reviewed at f1aa27f. The previous suggestion has been addressed correctly — the misleading "Docker Compose directly" framing is removed and the troubleshooting text now accurately directs users to config.yaml without implying Docker Compose reads it natively.
No new issues found. STRUCTURE.md additions and config.yaml key references remain accurate.
— Authored by egg
|
egg review completed. View run logs 3 previous review(s) hidden. |
* docs: update docs for config.yaml migration * docs: rephrase config.yaml troubleshooting per review feedback Remove misleading 'Docker Compose directly' framing since Docker Compose does not read config.yaml — it reads env vars set by the egg CLI. --------- Co-authored-by: jwbron <8340608+jwbron@users.noreply.github.com> Co-authored-by: egg-reviewer[bot] <261018737+egg-reviewer[bot]@users.noreply.github.com>
1 participant
Update documentation to reflect changes from d33bcb1 (Migrate .env to config.yaml, enable MCP by default):
config/config.yaml.exampleto the Config Directory listing; addshared/egg_config/compose_config.pyto the Shared Libraries listing — both new files introduced by this commit were missing from the project structure reference..envfile. Both the "Orchestrator won't start" item (HOST_UID/HOST_GID) and the "Empty repository" item (HOST_HOME) now point users to~/.config/egg/config.yamlwith the correct YAML syntax.Triggered by: #1049
Authored-by: egg