docs(framework): Add documentation on how to register supernode to su…#6237
Open
WilliamLindskog wants to merge 5 commits intomainfrom
Open
docs(framework): Add documentation on how to register supernode to su…#6237WilliamLindskog wants to merge 5 commits intomainfrom
WilliamLindskog wants to merge 5 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for registering SuperNodes to the Flower SuperGrid platform using authentication keys.
Changes:
- Creates a new how-to guide covering the complete SuperNode registration workflow
- Integrates the guide into the deployment documentation section
- Provides prerequisites, authentication setup, registration steps, and troubleshooting guidance
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| framework/docs/source/how-to-register-supernodes-on-supergrid.rst | New comprehensive guide with step-by-step instructions for SuperNode registration, including prerequisites, key generation, Docker setup, and troubleshooting |
| framework/docs/source/deploy.rst | Adds reference to the new SuperNode registration guide in the deployment documentation table of contents |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
docs(supergrid): Add documentation on how to register supernode to supergrid
Issue
Description
There was no comprehensive documentation guide for users who want to register SuperNodes to the Flower SuperGrid using authentication keys. Users needed a step-by-step guide covering the entire process from prerequisites to troubleshooting.
Related issues/PRs
N/A - This is a new documentation contribution.
Proposal
Explanation
Added a new comprehensive how-to guide
how-to-register-supernodes-on-supergrid.rstthat provides:The guide has been integrated into the deployment documentation section in
deploy.rst, positioned logically after the existing SuperNode authentication guide.Checklist
#contributions)Any other comments?
This documentation is based on the official SuperGrid registration workflow and provides users with all the information needed to successfully register and manage SuperNodes on the Flower SuperGrid platform.