Skip to content

Add comprehensive audit of Soroban getting-started documentation - #1

Open
kaankacar wants to merge 2 commits into
mainfrom
claude/audit-soroban-docs-014fYSWARX3NaBFAtm9CQ2qi
Open

kaankacar wants to merge 2 commits into
mainfrom
claude/audit-soroban-docs-014fYSWARX3NaBFAtm9CQ2qi

Conversation

@kaankacar

Copy link
Copy Markdown
Owner

This audit was performed from a first-time developer perspective with no prior Soroban/Stellar knowledge. Key findings:

CRITICAL ISSUES:

  • Missing system dependencies (libdbus-1-dev, libudev-dev) block installation
  • Network-dependent tutorial flow with no local alternative
  • SDK version mismatches (docs show v22, CLI generates v23.0.2)
  • Naming inconsistencies (hello_world vs hello-world)

HIGH PRIORITY:

  • Inconsistent extend_ttl() parameters in examples
  • Incorrect expected log output
  • crate-type configuration mismatch

RECOMMENDATIONS:

  • Add complete dependency list to setup docs
  • Restructure tutorial to prioritize local development
  • Add troubleshooting guide
  • Update version references
  • Add verification checkpoints

The report includes detailed execution logs, code artifacts, gap analysis, and prioritized recommendations for DevRel team.

This audit was performed from a first-time developer perspective with no
prior Soroban/Stellar knowledge. Key findings:

CRITICAL ISSUES:
- Missing system dependencies (libdbus-1-dev, libudev-dev) block installation
- Network-dependent tutorial flow with no local alternative
- SDK version mismatches (docs show v22, CLI generates v23.0.2)
- Naming inconsistencies (hello_world vs hello-world)

HIGH PRIORITY:
- Inconsistent extend_ttl() parameters in examples
- Incorrect expected log output
- crate-type configuration mismatch

RECOMMENDATIONS:
- Add complete dependency list to setup docs
- Restructure tutorial to prioritize local development
- Add troubleshooting guide
- Update version references
- Add verification checkpoints

The report includes detailed execution logs, code artifacts, gap analysis,
and prioritized recommendations for DevRel team.
Complete first-time developer audit covering all tutorial sections.

KEY FINDINGS:

DNS Resolution Failure (Testnet):
- Stellar CLI cannot resolve DNS in containerized environments
- Rust's DNS resolver differs from system DNS
- NOT a stellar-cli bug - environment-specific issue
- Affects developers in: CI/CD, containers, corporate networks
- Network IS reachable (curl works) but Rust resolver fails

CRITICAL DISCOVERY: Solution exists but not documented!
- 'stellar container start' provides full local network
- Runs stellar-core, horizon, RPC, friendbot locally
- Requires NO external network access
- Only mentioned at END of tutorial, not as primary path
- Should be THE recommended development workflow

RESULTS BY SECTION:
✅ Setup: 70% (dependency issues, but solvable)
✅ Hello World: 95% (perfect except version mismatches)
❌ Deploy Testnet: 0% (DNS failure, no documented alternative)
✅ Storing Data: 90% (works perfectly, doc inconsistencies)
❌ Deploy Increment: 0% (blocked by testnet)
❌ Frontend: 0% (blocked by deployment requirement)

COULD HAVE BEEN 100% with 'stellar container start' documented first!

COMPLETE DOCUMENTATION:
- 9 issues catalogued with severity ratings
- Detailed root cause analysis for each failure
- Specific fixes with time estimates
- Comprehensive recommendations (immediate, short-term, long-term)
- Success metrics proposals
- Tutorial restructuring recommendations

See report for full details on why testnet failed and how to fix docs.
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