Skip to content

(docs) Add burn period notice to validator guide#690

Merged
joellidin merged 2 commits intomainfrom
dev
Jan 21, 2026
Merged

(docs) Add burn period notice to validator guide#690
joellidin merged 2 commits intomainfrom
dev

Conversation

@joellidin
Copy link
Copy Markdown
Collaborator

@joellidin joellidin commented Jan 21, 2026

Add 100% burn period notification to docs/validator.md to align with
other documentation files. This completes the documentation update to
reflect the transition period after Covenant72B training.

  • Inform validators are burning 100% of emissions
  • Link to neurons/burn.py implementation
  • Note miner gradients are not being evaluated
  • Reference upcoming Templar: Crusades announcement

Description

Related Issue(s)

  • Closes #[issue number]

Type of Change

  • Feature (adding new functionality)
  • Fix (resolving a bug or issue)
  • Docs (documentation updates)
  • Refactor (code changes that don't affect functionality)
  • Maintenance (dependency updates or other maintenance)
  • Tests (adding or improving tests)
  • Breaking change (fix or feature with incompatible API changes)
  • Other: _____

Branch Naming

  • My branch follows the project's naming convention (e.g., feature/add-new-capability)

Commit Messages

  • My commits are small, atomic, and have proper commit messages
  • Commit messages are in imperative mood with a capitalized summary under 50 chars

Code Quality

  • I've performed a self-review of my code
  • I've added appropriate docstrings following the project's conventions
  • I've added proper logging where necessary (without trailing periods)
  • I've applied linting and formatting with Ruff
  • My code generates no new warnings

Testing

  • I've added tests for new functionality or bug fixes
  • All tests pass locally with my changes
  • Test coverage has not decreased

Documentation

  • I've updated documentation to reflect my changes
  • I've updated comments in hard-to-understand areas

If this is a breaking change

Screenshots/Examples

Additional Notes

Summary by CodeRabbit

  • Documentation
    • Added announcement of 100% burn period (January 2026) where miners are not evaluated and no emissions are distributed
    • Added notice of Covenant72B training completion
    • Introduced Templar: Crusades with forthcoming details
    • Added status warning banners across documentation

✏️ Tip: You can customize this high-level summary in your review settings.

Add 100% burn period notification to docs/validator.md to align with
other documentation files. This completes the documentation update to
reflect the transition period after Covenant72B training.

- Inform validators are burning 100% of emissions
- Link to neurons/burn.py implementation
- Note miner gradients are not being evaluated
- Reference upcoming Templar: Crusades announcement
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jan 21, 2026

Walkthrough

Documentation updates across multiple files announcing a 100% burn period active in January 2026, indicating miners are not evaluated and no emissions are distributed. Includes notifications about Covenant72B training completion and introduction of Templar: Crusades.

Changes

Cohort / File(s) Summary
Documentation Burn Period Banners
README.md, docs/README.md, docs/miner.md, docs/validator.md
Added informational warning banners and status updates across documentation indicating 100% burn period active, clarifying that miners are not evaluated and no emissions are distributed during this period. Includes references to Covenant72B completion and forthcoming Templar: Crusades details.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • templar#689: Applies identical documentation edits (adding "100% Burn Period Active" warnings and Covenant72B/Templar references) to the same set of files.

Poem

🔥 A burn period dawns, no emissions flow,
Miners rest while Covenant reaps what they sow,
Covenant72B's training complete,
Templar: Crusades makes the victory sweet! 🐰✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 inconclusive)
Check name Status Explanation Resolution
Description check ❓ Inconclusive The description provides context for the changes but lacks completion of the PR template checklist items (Type of Change, Branch Naming, Commit Messages, Code Quality, Testing, Documentation checkboxes remain unchecked). Check the appropriate 'Type of Change' option (Docs) and verify other template sections; ensure the checklist reflects the actual work performed.
✅ Passed checks (2 passed)
Check name Status Explanation
Title check ✅ Passed The title precisely describes the primary change: adding a burn period notice to the validator guide documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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


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.

@codecov
Copy link
Copy Markdown

codecov bot commented Jan 21, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

❌ Your project status has failed because the head coverage (57.69%) is below the target coverage (85.00%). You can increase the head coverage or adjust the target coverage.

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #690   +/-   ##
=======================================
  Coverage   57.69%   57.69%           
=======================================
  Files          27       27           
  Lines        4990     4990           
=======================================
  Hits         2879     2879           
  Misses       2111     2111           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@docs/miner.md`:
- Line 3: Add a short disclaimer under the "Miner Operations" heading indicating
that the 100% Burn Period is active and miners are not being evaluated nor
receiving emissions; update the "Training Process" and "Gradient Sharing"
subsections to include a one-sentence note (e.g., "Note: rewards/evaluation
paused during 100% Burn Period") so the flow text no longer implies normal
reward distribution and to point readers to the main README for status; ensure
the disclaimer appears prominently near the Miner Operations heading and is
replicated or referenced in the "Training Process" and "Gradient Sharing"
sections.

In `@docs/validator.md`:
- Line 3: Add a brief clarification near the "Evaluation Process" and/or
"Validator Operations" headings stating that evaluation steps are currently
paused during the 100% burn period (validators are burning emissions and not
evaluating miner gradients), and link to neurons/burn.py for the implementation
and the main README for status; update the text so it does not contradict the
banner by explicitly marking the evaluation workflow as suspended while the burn
period is active.

In `@README.md`:
- Around line 22-28: Update the burn-period heading and blurb that currently
reads "⚠️ 100% Burn Period Active (January 2026)" and the sentence "Templar is
currently in a 100% burn period. Miners are not being evaluated and no emissions
are being distributed." to include a clear timeframe: add the exact start date
and either an explicit end date or the phrase "until further notice" (e.g.,
"Start: 2026-01-01 — Until further notice") so the information stays accurate
after January; edit the two places where the timeframe appears in the README
content to use this new explicit wording.
🧹 Nitpick comments (1)
docs/README.md (1)

3-3: Align burn-period timeframe wording with root README.

This banner relies on the main README for status, but it would still help to include the same explicit timeframe (“since YYYY-MM-DD, until further notice”) for consistency and to avoid stale signals.

💡 Suggested wording
-> **⚠️ 100% Burn Period Active**: Miners are not being evaluated and no emissions are being distributed. See the main [README](../README.md) for current status and information about Templar: Crusades.
+> **⚠️ 100% Burn Period Active (since 2026-01-XX, until further notice)**: Miners are not being evaluated and no emissions are being distributed. See the main [README](../README.md) for current status and information about Templar: Crusades.

@joellidin joellidin merged commit 549f5cc into main Jan 21, 2026
7 of 8 checks passed
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.

1 participant