Skip to content

docs: Add troubleshooting section to QUICKSTART.md#2066

Merged
Scottcjn merged 1 commit intoScottcjn:mainfrom
dinnar1407-code:fix-docs-inconsistencies
Apr 5, 2026
Merged

docs: Add troubleshooting section to QUICKSTART.md#2066
Scottcjn merged 1 commit intoScottcjn:mainfrom
dinnar1407-code:fix-docs-inconsistencies

Conversation

@dinnar1407-code
Copy link
Copy Markdown
Contributor

First PR — Doc Fix

Ref: Scottcjn/rustchain-bounties#2783

Changes

Added a Troubleshooting section to docs/QUICKSTART.md with:

  • Common issues table (6 frequent problems with solutions)
  • Node status checking commands
  • Links to help resources (GitHub Issues, Discord, bounties)

This helps first-time users self-serve on common problems instead of opening duplicate issues.

Starred ⭐

Already starred the repo.

Added a common issues table and troubleshooting guide to help
first-time users resolve frequent problems without opening an issue.
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 4, 2026

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!

@github-actions github-actions bot added the size/XS PR: 1-10 lines label Apr 4, 2026
Copy link
Copy Markdown

@geldbert geldbert left a comment

Choose a reason for hiding this comment

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

Review: Troubleshooting Section Addition

Overall: Good addition that addresses real pain points for new users.

Line 410 - Connection refused entry

"The node may be restarting. Wait 30 seconds and retry."

  • This is imprecise. The wait time depends on network conditions and block confirmations. Suggest: "Wait 10-60 seconds depending on network load" or provide the actual rustchain status command to check node state.

Line 414 - SSL Certificate Error

"Your system clock may be wrong. Sync your clock..."

  • This is diagnostic but doesn't explain WHY it's linked to certificate validation. Add context: "SSL certificates include validity windows; a skewed clock causes certificate rejection before the root cause is obvious."

Line 416 - Low Hash Rate

"CPU mining is... expected."

  • The ~20 H/s figure should reference current blockchain difficulty, otherwise it will become dated very quickly. Consider: "Hash rate scales inversely with difficulty" with a link to current network stats.

Missing: Links to resources section

  • The "Resources" column entries like "Elyan Labs Discord" aren't hyperlinked (lines 418-420). Discord invite links are typically permanent but should be verified.

Suggestion

Consider adding a "Check Your Environment" subsection with proactive diagnostics that validates Python version, venv activation, and network connectivity in one shot. This table format is reactive troubleshooting; proactive diagnostics would complement it well.

@zhuzhushiwojia
Copy link
Copy Markdown

Great addition! This troubleshooting section will really help new users. Looking forward to more contributions! 👍

@zhuzhushiwojia
Copy link
Copy Markdown

Good documentation improvement! Adding a troubleshooting section is very helpful for new users.

Suggestions:

  • Consider adding common error messages and solutions
  • Could include FAQ section

LGTM! ✅

@Scottcjn
Copy link
Copy Markdown
Owner

Scottcjn commented Apr 5, 2026

Clean, useful troubleshooting section. The common issues table covers the real pain points new users hit. Merging.

RTC: 5 (docs contribution)

@Scottcjn Scottcjn merged commit 5844bb6 into Scottcjn:main Apr 5, 2026
3 checks passed
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.

4 participants