Skip to content

docs: document end of maintenance and add validator exit guide#1176

Merged
zakir-web3 merged 1 commit intomainfrom
docs/maintenance-notice-and-validator-exit
Apr 22, 2026
Merged

docs: document end of maintenance and add validator exit guide#1176
zakir-web3 merged 1 commit intomainfrom
docs/maintenance-notice-and-validator-exit

Conversation

@zakir-web3
Copy link
Copy Markdown
Contributor

@zakir-web3 zakir-web3 commented Apr 22, 2026

Summary

  • Add a prominent Maintenance status section at the top of the root README.md stating that official maintenance ended on March 1, 2026, and what that implies for validators (no guaranteed security fixes, upgrades, or release support).
  • Add a short validator checklist (decision to keep running, keys and unbonding, clean shutdown, archival, releases vs main, stale docs).
  • Add docs/validator-exit-guide.md with CLI and explorer steps to exit via self-delegation unbond, plus a brief Shutting down the node section. CLI examples correct the staking query usage (delegation / delegations-to / validator) relative to a prior external gist.
  • Link the guide from the README and from docs/README.md.

Notes

  • PR description and commit messages are in English only.
  • Validators are directed to tagged Releases for binaries, not main.

Summary by CodeRabbit

  • Documentation
    • Added maintenance status information stating official support for the repository and reference binaries ended on March 1, 2026.
    • Added comprehensive validator exit guide with step-by-step instructions covering exit decisions, key and fund safety considerations, unbonding and undelegation procedures, node shutdown steps, and important notes about unbonding periods and minimum self-delegation requirements.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 22, 2026

📝 Walkthrough

Walkthrough

Added a maintenance status notification to the main README indicating official maintenance ended March 1, 2026. Introduced comprehensive validator exit guide documentation with command-line and browser-based unbonding workflows. Added corresponding documentation reference link.

Changes

Cohort / File(s) Summary
Maintenance & Validator Exit Documentation
README.md, docs/README.md, docs/validator-exit-guide.md
Added maintenance status announcement to README with validator exit guidance link. Created new validator exit guide documenting step-by-step unbonding procedures, node shutdown, and key operational considerations. Updated docs index with exit guide reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐰✨ The hopping guide is now complete,
For validators' graceful retreat,
Unbond with care, shutdown with grace,
A hop forward from this place! 🌙

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title accurately describes the main changes: adding documentation about end of maintenance and a validator exit guide, which aligns with all modified files (README.md, docs/README.md, and the new validator-exit-guide.md).

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/maintenance-notice-and-validator-exit

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@zakir-web3 zakir-web3 changed the title Document end of maintenance and add in-repo validator exit guide docs: document end of maintenance and add validator exit guide Apr 22, 2026
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
README.md (1)

7-7: Optional: Consider rephrasing "A small number of".

The current phrasing is clear and correct. If you prefer tighter wording, you could simplify to "Some validators" or "A few validators", but this is purely stylistic.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 7, Replace the phrase "A small number of validators may
still be online;" in the README sentence that starts with "Official
maintenance..." with a tighter wording such as "Some validators may still be
online;" or "A few validators may still be online;" — update that clause in the
same sentence to keep meaning identical but use the preferred shorter phrasing.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@README.md`:
- Line 7: Replace the phrase "A small number of validators may still be online;"
in the README sentence that starts with "Official maintenance..." with a tighter
wording such as "Some validators may still be online;" or "A few validators may
still be online;" — update that clause in the same sentence to keep meaning
identical but use the preferred shorter phrasing.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 712e76d1-9a82-486a-9874-791f522e1c5e

📥 Commits

Reviewing files that changed from the base of the PR and between 3e59bd4 and 1019122.

📒 Files selected for processing (3)
  • README.md
  • docs/README.md
  • docs/validator-exit-guide.md

@zakir-web3 zakir-web3 merged commit e072af2 into main Apr 22, 2026
5 of 7 checks passed
@zakir-web3 zakir-web3 deleted the docs/maintenance-notice-and-validator-exit branch April 22, 2026 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants