Skip to content

docs(framework): Add documentation on how to register supernode to su…#6237

Open
WilliamLindskog wants to merge 5 commits intomainfrom
docs/supernode-to-supergrid
Open

docs(framework): Add documentation on how to register supernode to su…#6237
WilliamLindskog wants to merge 5 commits intomainfrom
docs/supernode-to-supergrid

Conversation

@WilliamLindskog
Copy link
Copy Markdown
Member

@WilliamLindskog WilliamLindskog commented Dec 2, 2025

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.rst that provides:

  • Complete prerequisites and setup instructions
  • Step-by-step authentication key generation process
  • Project configuration details
  • SuperGrid login and verification procedures
  • Detailed SuperNode registration workflow
  • Docker-based SuperNode initialization instructions
  • Federated task execution guidance
  • Common troubleshooting scenarios and solutions
  • Quick reference commands and checklist

The guide has been integrated into the deployment documentation section in deploy.rst, positioned logically after the existing SuperNode authentication guide.

Checklist

  • Implement proposed change
  • Write tests (N/A for documentation)
  • Update documentation
  • Make CI checks pass
  • Ping maintainers on Slack (channel #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.

@WilliamLindskog WilliamLindskog changed the title docs(supergrid): Add documentation on how to register supernode to su… docs(framework): Add documentation on how to register supernode to su… Dec 2, 2025
@github-actions github-actions Bot added the Maintainer Used to determine what PRs (mainly) come from Flower maintainers. label Dec 2, 2025
Copilot AI review requested due to automatic review settings February 6, 2026 12:52
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Maintainer Used to determine what PRs (mainly) come from Flower maintainers.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants