docs: Add troubleshooting section to QUICKSTART.md#2066
docs: Add troubleshooting section to QUICKSTART.md#2066Scottcjn merged 1 commit intoScottcjn:mainfrom
Conversation
Added a common issues table and troubleshooting guide to help first-time users resolve frequent problems without opening an issue.
|
Welcome to RustChain! Thanks for your first pull request. Before we review, please make sure:
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! |
geldbert
left a comment
There was a problem hiding this comment.
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 statuscommand 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.
|
Great addition! This troubleshooting section will really help new users. Looking forward to more contributions! 👍 |
|
Good documentation improvement! Adding a troubleshooting section is very helpful for new users. Suggestions:
LGTM! ✅ |
|
Clean, useful troubleshooting section. The common issues table covers the real pain points new users hit. Merging. RTC: 5 (docs contribution) |
First PR — Doc Fix
Ref: Scottcjn/rustchain-bounties#2783
Changes
Added a Troubleshooting section to
docs/QUICKSTART.mdwith:This helps first-time users self-serve on common problems instead of opening duplicate issues.
Starred ⭐
Already starred the repo.