docs: document YAML configuration - #27
Open
coderberry wants to merge 1 commit into
Open
Conversation
coderberry
force-pushed
the
docs/yaml-configuration-guide
branch
from
August 13, 2026 16:28
7f115c6 to
f06d00e
Compare
coderberry
marked this pull request as ready for review
August 13, 2026 21:08
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Add a canonical YAML configuration guide for both the global
config.yamlfile and project-specific.heard.yamlfiles.The guide documents current-main settings, defaults, scope, precedence, project labels, narration preferences, direct-YAML event filters, provider and privacy controls, credential safety, inspection commands, and troubleshooting. It is linked from the README's Tuning and self-host sections, and the contributor checklist now requires configuration documentation to stay in sync.
Why?
Heard's configuration surface has grown faster than its documentation. Users could discover
.heard.yaml, but not reliably determine which options worked globally, which were project-capable, how nested project files resolved, or which persisted keys were internal or inert.How?
The reference is derived from the current config loader, CLI validation, preference schema, adapter behavior, daemon consumers, and tests. It separates supported controls from internal state, calls out the nearest-file and shallow merge rules, documents adapter-specific timing limitations, and warns against placing credentials in repository files.
Testing?
.venv/bin/ruff check heard/ tests/— passed..venv/bin/pytest -q— 956 passed in 570.77 seconds.preference slots against current source.
git diff --check upstream/main..HEAD— passed.Anything Else?
This is documentation-only and changes no runtime behavior. Review should focus on the scope and precedence descriptions in
docs/configuration.md.