The document covers workspace, github, and ide config sections in separate code blocks but never shows a single fully populated ~/.base.d/config.yaml. A user configuring their machine for the first time has to mentally assemble the complete file from four disconnected blocks and must infer that each is a top-level YAML key. This is particularly error-prone for the ide section with its nested keys. Additionally, the github.default_owner example uses a personal GitHub username rather than a generic placeholder, which could confuse users.
Fix: Add a "Complete Example" subsection near the top showing a fully populated config with all supported fields and brief inline comments. Replace personal usernames with generic placeholders like your-github-username.
File: docs/local-config.md
The document covers
workspace,github, andideconfig sections in separate code blocks but never shows a single fully populated~/.base.d/config.yaml. A user configuring their machine for the first time has to mentally assemble the complete file from four disconnected blocks and must infer that each is a top-level YAML key. This is particularly error-prone for theidesection with its nested keys. Additionally, thegithub.default_ownerexample uses a personal GitHub username rather than a generic placeholder, which could confuse users.Fix: Add a "Complete Example" subsection near the top showing a fully populated config with all supported fields and brief inline comments. Replace personal usernames with generic placeholders like
your-github-username.File:
docs/local-config.md