Rishabh rsinghvi patch 2

[rishabhRsinghvi]

Description of Changes

Overview

The existing documentation on forking in Dojo has been significantly enhanced to provide more clarity, detailed instructions, and additional examples. These improvements aim to make it easier for developers to understand and effectively use the forking feature for their testing and development needs.

Changes Made

1. Introduction and Explanation:

   • The introduction has been rephrased to highlight the benefits of forking in Dojo, specifically focusing on its role in replicating the state of live networks locally.
   • Added a detailed explanation of how forking works, including what components are included in the forked state.

2. Configuration Instructions:

   • Clear instructions on how to configure the Katana node with a valid RPC provider.
   • Explanation of how to fork from a specific block using the --fork-block-number flag.

3. Interaction with Forked Network:

   • Expanded details on how to interact with the forked network using familiar Starknet APIs and tools.
   • Instructions on deploying custom smart contracts and simulating transactions using predeployed accounts.

4. Examples:

   • Provided a variety of example commands to illustrate different use cases, including:
     • Basic forking command.
     • Forking from different networks (mainnet, testnet).
     • Using environment variables for configuration.
     • Forking from a specific block range.
   • Added advanced use cases for debugging smart contracts, performance testing, and security audits.

5. Best Practices:

   • Added a section on best practices to guide developers on environment isolation, automated testing, resource management, and continuous improvement.

6. Future Enhancements:

   • Outlined the commitment to future enhancements of the forking feature, ensuring developers are aware of ongoing improvements.

Reasons for Changes

• Clarity and Comprehensiveness: The original documentation lacked detail in explaining the forking feature and its configuration. The revised content provides a thorough understanding, making it easier for developers to follow.
• Practical Examples: Including practical examples helps developers quickly grasp how to use the forking feature in various scenarios, from basic usage to advanced testing and debugging.
• Best Practices: Highlighting best practices ensures developers can use the forking feature efficiently and avoid common pitfalls.
• Future-Proofing: Mentioning future enhancements keeps developers informed about upcoming features and improvements, encouraging them to stay updated with the latest capabilities.

By incorporating these changes, the documentation now offers a more robust and user-friendly guide to leveraging the forking feature in Dojo, ultimately enhancing the developer experience and promoting effective testing and development practices.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
book	✅ Ready (Inspect)	Visit Preview	Jun 5, 2024 3:35pm

[glihm]

Thank you @rishabhRsinghvi for your will to contribute, but majority of the content proposed here is not accurate. Please don't hesitate to take any open issue instead. 🙏

[rishabhRsinghvi]

@glihm can you please elaborate, what's not correct, it's my first contribution.