chore: rename config files (minimal + reference)#326
Merged
Conversation
config.json.template -> config.minimal.json (the bare-minimum starter: just the two payout addresses, copied to config.json) config.advanced.example.json -> config.reference.json (the full reference: every key with its default value) The names now say what each file is. Content is unchanged — the reference already documents every config key (verified against docs/configuration.md), and the minimal file is still just the wallet addresses. Updated all references (CLI text, README, getting-started, configuration, releasing, the release bundle, and the bundle test). CHANGELOG entries keep the old names — those releases really did ship them. Co-Authored-By: Claude Opus 4.8 <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.
What
Rename the two config files so the names say what they are, and confirm their content matches that role.
config.json.templateconfig.minimal.jsonconfig.jsonand run setup.config.advanced.example.jsonconfig.reference.jsonNames are now consistent with RigForge (same pair, same PR).
Content
No content change was needed:
config.reference.jsonis already complete — it documents every key the code reads. Verified against thedocs/configuration.mdreference table (the only "gap" wasmonero.remote, which is present as an object withhost/rpc_port/zmq_port).config.minimal.jsonis still minimal —monero.wallet_address+tari.wallet_address, nothing else.References updated
CLI text (
pithead),README.md,docs/getting-started.md,docs/configuration.md,docs/releasing.md, the release bundle (scripts/release.sh), and the bundle test (tests/stack/run.sh).CHANGELOG.mdkeeps the old names — those past releases really did shipconfig.json.template/config.advanced.example.json, so changing them would be historically wrong.Verification
jq— both files valid JSONtests/stack/run.sh— 414 pass (incl. the updated "bundle shipsconfig.minimal.json" assertion)shellcheck(pithead, release.sh, run.sh),markdownlint— cleanNOTE: this touches a few of the same doc files as the open voice-consistency PR (#325); whichever lands first, the other rebases with a small conflict on the filename lines.
🤖 Generated with Claude Code