Improve docs #1729

Activity

1. kenrogers

   added

   documentation

   on Oct 1, 2025
2. kenrogers commented on Oct 1, 2025

   

   kenrogers

   on Oct 1, 2025

   ContributorAuthor

   More actions

   @claude please review the existing docs and suggest any improvements that should be made to improve the developer experience

   👀React with 👀1Reacted by claude
3. kenrogers commented on Oct 1, 2025

   

   kenrogers

   on Oct 1, 2025

   ContributorAuthor

   More actions

   Did you perform the above request @claude ?

   👀React with 👀1Reacted by claude
4. kenrogers commented on Oct 1, 2025

   

   kenrogers

   on Oct 1, 2025

   ContributorAuthor

   More actions

   @claude take a look at this and provide recommendations on how to improve the quickstart, if any

   👀React with 👀1Reacted by claude
5. claude commented on Oct 1, 2025

   

   claudeBot

   on Oct 1, 2025 – with Claude

   Last edited by claude

   More actions

   Claude finished @kenrogers's task —— View job

   ---

   Quickstart Documentation Review Complete ✅

   I've completed a thorough review of the Developer Quickstart tutorial at guides-and-tutorials/hello-stacks-quickstart-tutorial.md. Overall, this is excellent documentation with clear structure, helpful examples, and great educational content. Here are my recommendations for improvement:

   🎯 High-Priority Improvements

   1. Add troubleshooting section

      • The tutorial jumps straight into success paths but doesn't cover common errors
      • Add a "Common Issues" section covering:
        • Wallet connection failures
        • Contract deployment errors (insufficient funds, syntax errors)
        • Network mismatch issues (testnet vs mainnet)
        • Transaction timeout/confirmation issues
        • CORS issues when running locally

   2. Clarify the CONTRACT_ADDRESS format

      • Line 340 says to replace with "YOUR_CONTRACT_ADDRESS_HERE"
      • Line 656 shows it should look like ST1ABC...123.message-board
      • This is confusing - the format shown includes the contract name, but the code has separate CONTRACT_ADDRESS and CONTRACT_NAME variables
      • Should clarify that CONTRACT_ADDRESS should be just the address (e.g., ST1ABC...123), not including the contract name

   3. Add expected timeframes for transactions

      • Users should know how long to wait for:
        • Contract deployment (~30-60 seconds)
        • Message posting (~30 seconds)
        • When to worry something went wrong

   4. Include prerequisites installation check

      • Add a quick verification step at the beginning:
        • Check Node.js version compatibility
        • Verify npm is installed
        • Confirm browser extension support

   💡 Medium-Priority Improvements

   5. Enhance the "What you'll learn" section

      • Add: "How to read from and write to the Stacks blockchain"
      • Add: "Understanding testnet vs mainnet"
      • This sets clearer expectations

   6. Add visual aids

      • Screenshot of Leather wallet on testnet (many users miss this step)
      • Screenshot of where to find contract address in explorer
      • Screenshot of the "allow mode" toggle for post conditions (mentioned at line 293 but not shown)

   7. Improve code example accessibility

      • The frontend code (327-529) is a large block with minimal explanation
      • Consider breaking it into smaller chunks with explanations:
        • Wallet connection logic
        • Reading from blockchain
        • Writing to blockchain
        • State management

   8. Add security notes

      • Mention that testnet tokens have no value but warn about mainnet deployment costs
      • Add note about keeping seed phrases secure (even for testnet)
      • Explain post conditions more thoroughly (currently just a link at line 293)

   🔧 Minor Improvements

   9. Fix inconsistent link formatting

      • Line 53: Uses relative path clarity-crash-course.md
      • Line 683: Uses full URL https://docs.stacks.co/docs/clarity
      • Should be consistent - prefer relative paths for internal docs

   10. Update example transaction link

       • Line 287 has an example transaction - verify it's still accessible
       • Consider adding more example links (deployed contract, successful message post)

   11. Add "Time to completion" badges

       • Each step already has time estimates in headers
       • Consider adding cumulative time (e.g., "Total: ~30 minutes, Steps 1-2: 15 min")

   12. Expand "Next Steps" section

       • Current next steps are good but could include:
         • Link to sBTC builder quickstart for Bitcoin integration
         • Suggest building a more complex version (edit/delete messages, likes, user profiles)
         • Link to the Clarity Crash Course mentioned earlier

   📝 Content Accuracy Check

   13. Verify external links

       • leather.io (line 32)
       • Stacks Testnet Faucet (line 35)
       • Clarity Playground (line 57)
       • All links in "Next Steps" section
       • Ensure all are current and accessible

   14. Technical accuracy

       • The get-recent-messages function (lines 96-105) has a limitation - it's hardcoded to return max 5 messages using list u1 u2 u3 u4 u5
       • This should be noted as a simplification for the tutorial, or better yet, explained why Clarity doesn't support dynamic lists easily

   ✨ Enhancement Ideas

   15. Add a video walkthrough

       • Line 31 shows docs support embedded YouTube videos
       • A quick video showing the full process would help visual learners

   16. Create a "What went wrong?" debugging guide

       • Interactive flowchart: "Can't see your message? → Check these things..."
       • Common error messages and their solutions

   17. Add deployment alternatives

       • Currently only shows Stacks Explorer Sandbox
       • Could mention Clarinet for local development and deployment
       • Hiro Platform as another option

   🎓 Learning Experience Enhancements

   18. Add "Test Your Understanding" checkpoints

       • After Step 2: "Can you add a function to delete a message?"
       • After Step 4: "How would you display the message author?"
       • These encourage deeper engagement

   19. Provide a complete GitHub repository

       • Mention if there's a working example repo they can clone
       • Useful for those who get stuck or want to compare their work

   20. Add a "Deploy to Mainnet" bonus section

       • For users who want to take it further
       • Explain the differences and costs involved

   Summary

   The quickstart is very well written with excellent code examples and explanations. The deep dive section is particularly impressive. The main areas for improvement are:

   • Adding practical troubleshooting help
   • Clarifying potentially confusing details (contract address format, post conditions)
   • Including more visual aids
   • Expanding error handling guidance

   These improvements would make an already strong tutorial even more accessible to newcomers and reduce friction points where developers commonly get stuck.

   ---

   Job Run | Branch
6. pheobeayo commented on Oct 30, 2025

   

   pheobeayo

   on Oct 30, 2025

   More actions

   @kenrogers Can I take up this issue?