docs(config): add descriptive-only banner to risk.yaml.example#176
Merged
Conversation
Live config is in alpha-engine-config/executor/risk.yaml; edits to the .example file affect only new-env bootstrap + public-repo schema docs. Banner sits at the top of the file so anyone (Claude included) opening the file sees the warning before assuming an edit reaches production. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Summary
Adds a banner to the top of
config/risk.yaml.examplewarning that edits here have ZERO runtime effect — production readsalpha-engine-config/executor/risk.yaml. The.examplefile is descriptive-only: it bootstraps new environments viasetup-trading-ec2.sh+ serves as public-repo schema docs for the executor's config surface.Motivated by a recurring lapse pattern (memory
feedback_yaml_example_descriptive_only_live_config_in_config_repoalready captures the rule; I keep editing.examplefiles anyway). Putting the banner at the top of each file makes the warning impossible to miss.Companion banners in 5 other repos shipping as separate PRs.
Test plan
python -c "import yaml; yaml.safe_load(...)")🤖 Generated with Claude Code