fix: document Substrate chains/ directory naming#23
Merged
Conversation
Clarify YAML chain_id vs on-disk segment (hyphens to underscores) in README and CONFIG.md. Made-with: Cursor
There was a problem hiding this comment.
Pull request overview
This PR updates documentation to clarify the relationship between the YAML chain_id value and the actual on-disk chains/ directory segment used by Substrate (hyphens in chain_id are normalized to underscores on disk), aligning the docs with the codebase’s path normalization behavior.
Changes:
- Clarify in README that Substrate normalizes
chain_idhyphens to underscores for thechains/directory name. - Update
docs/CONFIG.mdto describechain_idas a logical id and document the normalization rule with examples. - Refine snapshot extraction path placeholders to reference the normalized (Substrate) directory name.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| README.md | Adds a brief clarification about Substrate chains/ directory normalization (hyphens → underscores). |
| docs/CONFIG.md | Updates chain_id and snapshot documentation to consistently reference the normalized on-disk chain directory segment. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
todvildes
approved these changes
Mar 31, 2026
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.
Clarify YAML chain_id vs on-disk segment (hyphens to underscores) in README and CONFIG.md.