docs: Add details about State Sync configuration [DEV-5269] #58
Conversation
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
Contributor
|
Task linked: DEV-5269 Update docs and prepare a state sync script |
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for State Sync configuration, which allows node operators to initialize their nodes quickly with significantly less storage requirements compared to traditional snapshot restoration.
- New State Sync configuration guide with manual setup instructions and automated script
- Updated system requirements to reflect different storage needs based on initialization method
- Enhanced installer documentation to include State Sync as an initialization option
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/setup-and-configure/set-up-state-sync.md | New comprehensive guide for State Sync configuration with manual and scripted setup options |
| docs/setup-and-configure/requirements.md | Updated storage requirements to differentiate between State Sync, snapshot, and archive node needs |
| docs/setup-and-configure/README.md | Updated installer documentation to include State Sync initialization option and version examples |
| SUMMARY.md | Added State Sync configuration guide to documentation table of contents |
| .github/linters/mlc_config.json | Added HTTP 429 status code to allowed list for link checking |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Eengineer1
previously approved these changes
Sep 19, 2025
Member
Eengineer1
left a comment
Eengineer1
left a comment
There was a problem hiding this comment.
I'm approving general instructions, but consider correcting any surfaced typos.
Feel free to merge into develop after.
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.
No description provided.