-
Notifications
You must be signed in to change notification settings - Fork 74
Add Remix IDE (new IA) #1174
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: staging/product-ia
Are you sure you want to change the base?
Add Remix IDE (new IA) #1174
Conversation
β¦Contract' section in navigation
There was a problem hiding this 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 updates the Remix IDE documentation to reflect the migration from Polkadot-specific Remix IDE (remix.polkadot.io) to the standard Ethereum Remix IDE (remix.ethereum.org) for use with Polkadot Hub. The changes update references, wallet providers, and add comprehensive troubleshooting documentation.
- Migrated from Polkadot Remix IDE to standard Ethereum Remix IDE
- Updated wallet provider from Talisman to MetaMask as the primary example
- Added comprehensive troubleshooting guide with common issues and solutions
Reviewed Changes
Copilot reviewed 4 out of 21 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| troubleshooting.md | Added new comprehensive troubleshooting guide covering compilation, wallet connection, deployment, contract interaction, and browser issues |
| get-started.md | Updated to reference remix.ethereum.org and MetaMask instead of Polkadot-specific IDE and Talisman; removed deployment/interaction sections (moved to separate file) |
| deploy-a-contract.md | Added new guide focused on contract deployment and interaction using wallet providers |
| .nav.yml | Commented out "Verify a Contract" navigation item with TODO note |
π‘ Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Automated style guide suggestions (1-15 of 15)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
Handled robot feedbacks. Once this gets tech review, I'll run through it one more time. |
brunopgalvao
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Left one comment.
|
I updated the formatting on the Troubleshooting page to use the FAQ interface style admonitions. You'll need to serve it with: papermoonio/polkadot-mkdocs#173 to see the correct formatting. |
dawnkelly09
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ready for a sanity check by Erin. Needs mkdocs PR: papermoonio/polkadot-mkdocs#173 for proper styling of troubleshooting/faq page
eshaben
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
gahhhhhh I commented on the AI pages π€¦ββοΈ - no going back now haha, sorry
| categories: Smart Contracts, Tooling | ||
| --- | ||
|
|
||
| # Remix IDE Troubleshooting and FAQs |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's no FAQs on this page so this title just doesn't really fit
|
|
||
| This guide provides solutions to common issues you may encounter when using Remix IDE with Polkadot Hub. If you're experiencing problems with compilation, deployment, or contract interaction, you'll likely find the solution here. | ||
|
|
||
| ## Problem: Contract fails to compile or shows errors in the terminal. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep headers consistent please and remove Problem or keep it. Also I would remove the punctuation at the end of all these
| @@ -0,0 +1,205 @@ | |||
| --- | |||
| title: Troubleshooting and FAQs | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remember this is for SEO purposes and is what shows up on search engines, so what's going to differentiate this title on google compared to the Hardhat Troubleshooting page?
| @@ -0,0 +1,205 @@ | |||
| --- | |||
| title: Troubleshooting and FAQs | |||
| description: Solutions to common issues when developing, compiling, and deploying smart contracts using Remix IDE on Polkadot Hub. | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
3 characters too short.
|
|
||
| Learn how to deploy and interact with smart contracts using Remix. | ||
|
|
||
| [:octicons-arrow-right-24: Get Started](/smart-contracts/dev-environments/remix/deploy-a-contract) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Trailing slashes missing
| - A web browser with [MetaMask](https://metamask.io/){target=\_blank} extension installed. | ||
| - Basic understanding of Solidity programming. | ||
| - Some WND test tokens to cover transaction fees (easily obtainable from the [Polkadot faucet](https://faucet.polkadot.io/westend?parachain=1000){target=\_blank}). | ||
| - Some DOT test tokens to cover transaction fees (easily obtainable from the [Polkadot faucet](/smart-contracts/faucet/){target=\_blank}). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
DOT? Is this right?
| 3. Write your Solidity code in the editor. | ||
|
|
||
| You can use the following code as an example: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This spacing looks a little weird, can we just move it to one line?
|
|
||
| 1. Navigate to the **Solidity Compiler** tab (third icon in the left sidebar). | ||
| 2. Select **Compile** or use `Ctrl+S`. | ||
| 1. Navigate to the **Solidity Compiler** tab (third icon in the left sidebar). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking at the gif, looks like the 4th icon now. I don't think we should callout the order in which it appears, cause we can't predict when that will change
| 1. After compiling your contract, you can navigate to the **File Explorer** tab (first icon in the left sidebar) and check that: | ||
| 1. The `artifact` folder is present. | ||
| 3. After compiling your contract, you can navigate to the **File Explorer** tab (first icon in the left sidebar) and check that: | ||
| 1. The `artifacts` folder is present. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a UI element = bold
| ## Where to Go Next | ||
|
|
||
| The Polkadot Remix IDE offers an environment for developing, compiling, and deploying smart contracts on Asset Hub. Its intuitive interface allows developers to easily write Solidity code, compile contracts, and interact with them directly in the browser. | ||
| The Remix IDE offers an environment for developing, compiling, and deploying smart contracts on the Polkadot Hub. Its intuitive interface allows developers to easily write Solidity code, compile contracts, and interact with them directly in the browser. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| The Remix IDE offers an environment for developing, compiling, and deploying smart contracts on the Polkadot Hub. Its intuitive interface allows developers to easily write Solidity code, compile contracts, and interact with them directly in the browser. | |
| Remix offers an environment for developing, compiling, and deploying smart contracts on Polkadot Hub. Its intuitive interface allows developers to easily write Solidity code, compile contracts, and interact with them directly in the browser. |
π Description
Provide a clear and concise description of your changes.
π Review Preference
Choose one:
π€ AI-Ready Docs
If content changed, regenerate AI files:
python3 scripts/generate_llms.pyβ Checklist