Skip to content

Conversation

@nhussein11
Copy link
Collaborator

📝 Description

This pull request updates and improves the documentation for replaying and dry-running XCMs using Chopsticks. The changes focus on clarifying instructions, improving consistency, updating references, and enhancing the overall readability of the guide.

Documentation improvements and clarifications:

  • Updated references to Chopsticks and related guides to point to current documentation URLs and improved descriptions of prerequisites and setup steps. [1] [2]
  • Clarified instructions for identifying XCMs, setting up environment variables, and using tools like Subscan and Polkadot.js Apps. [1] [2]
  • Improved step-by-step guidance for creating and running replay and dry-run scripts, including clearer file naming and code block annotations. [1] [2]

Consistency and language improvements:

  • Standardized bullet points and terminology throughout the guide (e.g., "behavior" instead of "behaviour") and improved explanations of the benefits of using Chopsticks for XCM debugging. [1] [2]
  • Enhanced the "Where to Go Next" section with updated links and clearer descriptions for further learning resources.

🔍 Review Preference

Choose one:

  • ✅ I have time to handle formatting/style feedback myself
  • ⚡ Docs team handles formatting (check "Allow edits from maintainers")

🤖 AI-Ready Docs

If content changed, regenerate AI files:

  • ✅ I ran python3 scripts/generate_llms.py
  • ⚡ Docs team will regenerate (check "Allow edits from maintainers")

✅ Checklist

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR migrates and improves the XCM replay documentation by enhancing clarity, updating references, and standardizing formatting. The changes focus on making the guide more accessible and consistent while maintaining technical accuracy.

Key changes:

  • Updated Chopsticks documentation references and streamlined the introduction section
  • Standardized terminology (e.g., "behavior" instead of "behaviour") and improved bullet point formatting
  • Enhanced code block annotations with proper titles and clarified setup instructions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

@brunopgalvao brunopgalvao left a comment

Choose a reason for hiding this comment

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

For the "Initialize a new Node project:" section, I think you need to add && npm pkg set type=module for the package.json to use module.

Copy link
Contributor

@brunopgalvao brunopgalvao left a comment

Choose a reason for hiding this comment

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

Let's refactor this guide to reference Polkadot Hub as much as possible instead of Asset Hub.

@eshaben eshaben changed the base branch from staging/product-ia to eshaben/enable-ci December 19, 2025 18:38
@eshaben
Copy link
Collaborator

eshaben commented Dec 19, 2025

@nhussein11 wasn't fully sure what I could change, like if I could change code elements that say asset hub to polkadot hub, so I didn't make any changes on that front. But, the rest of the guide is in good shape.

@nhussein11
Copy link
Collaborator Author

Let's refactor this guide to reference Polkadot Hub as much as possible instead of Asset Hub.

@nhussein11 wasn't fully sure what I could change, like if I could change code elements that say asset hub to polkadot hub, so I didn't make any changes on that front. But, the rest of the guide is in good shape.

@brunopgalvao @ericmorel thanks! fixed in 10399e7

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.

4 participants