Skip to content

docs: fix sprint epoch endpoint#5218

Merged
Scottcjn merged 1 commit into
Scottcjn:mainfrom
iamdinhthuan:docs-fix-sprint-epoch-endpoint
May 14, 2026
Merged

docs: fix sprint epoch endpoint#5218
Scottcjn merged 1 commit into
Scottcjn:mainfrom
iamdinhthuan:docs-fix-sprint-epoch-endpoint

Conversation

@iamdinhthuan
Copy link
Copy Markdown

Summary

  • Update sprint FAQ epoch examples from the stale /api/epoch path to the live /epoch endpoint
  • Keep both epoch-status and total-weight examples aligned with the current public API

Verification

Bounty: #2178

Copy link
Copy Markdown

@haocyan0723-code haocyan0723-code left a comment

Choose a reason for hiding this comment

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

I checked the two endpoint examples against the live site.

Good catch on the stale path: https://rustchain.org/api/epoch returns 404, while https://rustchain.org/epoch returns 200 with epoch data, so the first replacement is correct.

One thing still needs attention in the second example, though: the live /epoch response I get does not include total_weight. It currently returns fields like blocks_per_epoch, enrolled_miners, epoch, epoch_pot, slot, and total_supply_rtc, so this command still prints null:

curl -sk https://rustchain.org/epoch | jq .total_weight

That means the endpoint path is fixed, but the “Check total network weight” snippet is still not usable as written. Either the docs need the current field/API that exposes network weight, or that example should be rewritten to match what /epoch actually returns.

I would keep the first change and adjust the second snippet before merging.

@guangningsun
Copy link
Copy Markdown
Contributor

PR Review — Standard Quality ✓

PR: #5218 — Docs: fix sprint epoch endpoint

What I reviewed

  • rustchain-miner/README.md

Observations

  1. Fixing the sprint epoch endpoint documentation — the diff shows a change to an endpoint URL or description related to epoch operations. Accurate documentation ensures miners can correctly query epoch status.

  2. Documentation fixes reduce support burden — when docs are accurate, contributors don't need to ask clarifying questions.

LGTM.

Bounty: #2782
Disclosure: I received RTC compensation for this review.

@github-actions github-actions Bot added documentation Improvements or additions to documentation size/XS PR: 1-10 lines labels May 14, 2026
@github-actions
Copy link
Copy Markdown
Contributor

Welcome to RustChain! Thanks for your first pull request.

Before we review, please make sure:

  • Your PR has a BCOS-L1 or BCOS-L2 label
  • New code files include an SPDX license header
  • You've tested your changes against the live node

Bounty tiers: Micro (1-10 RTC) | Standard (20-50) | Major (75-100) | Critical (100-150)

A maintainer will review your PR soon. Thanks for contributing!

@Scottcjn Scottcjn merged commit 02378ca into Scottcjn:main May 14, 2026
11 of 12 checks passed
Copy link
Copy Markdown
Contributor

@HCIE2054 HCIE2054 left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for contributing!

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

Labels

documentation Improvements or additions to documentation size/XS PR: 1-10 lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants