-
Notifications
You must be signed in to change notification settings - Fork 86
docs: add intro page, improve layout page #186
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: master
Are you sure you want to change the base?
Conversation
| @@ -1,15 +1,12 @@ | |||
| ## Remix is composed of four panels. | |||
|  | |||
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.
you are missing an h in https in the URL
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 max size for an image size in learneth is probably 600px. It could link to a larger image. But the image at the size you have it is too large to work. There might be another example in the tutorials of links to an image or PDF
|
|
||
| ## How Remix is Structured | ||
|
|
||
| Think of Remix as three layers: |
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.
So the 3 layers are: Workspaces & Files, Plugins, and Network & Accounts?
That doesn't seem quite right.
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.
I think the old version was more direct to introducing them to the layout.
| @@ -0,0 +1,36 @@ | |||
| Remix IDE is a browser-based (also includes a desktop variant) development environment for building, testing, and shipping smart contracts. It’s designed to remove setup friction, make feedback loops tight, and help you reason about what’s really happening on-chain. | |||
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.
I think people who come to this tutorial are wondering how to use to the tool, and not why to use it. This general intro seems like a distraction. Maybe this is better in your intro to Blockchain tutorial.
| You might also include plugins like Ethers/Web3 for calls, coverage and gas reporters for quality, and linters or formatters for consistency. All this is before you write a single line of contract code. | ||
|
|
||
| Remix compresses this process in your browser and all you need to do is open a URL (remix.ethereum.org), write Solidity (or Vyper via plugin), compile, deploy to a network, and interact with your contracts, all in one place. | ||
|
|
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.
From here up - the same comment as above. It could be that your intro to blockchain is an intro to blockchain development.
| In the **Main Panel** of Remix, make sure you see the **Home** tab. The **Home** tab has lots of useful links. To navigate there, either click the **Home** tab in the **Main Panel** or click the Remix icon  on the top of the icon panel. | ||
|
|
||
| - See all the plugins in the **Plugin Manager**. Click this icon  in the lower left corner Remix. | ||
| **TIP: You can make a panel larger (or smaller) by dragging its border.** |
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.
You can make a panel wider
(dont' mention narrower because it should be understood)
| 3. In the modal the comes up, choose one of the templates. | ||
| 3. In the modal the comes up, choose one of the templates. | ||
|
|
||
|  |
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.
New image needed.
| Let's create a new Workspace | ||
|
|
||
| 1. At the top of the File Explorer, click the hamburger icon (the 3 horizontal lines). Read through the commands and tools in this menu. | ||
| 1. At the top of the File Explorer, click the hamburger icon (the 3 horizontal lines). Read through the commands and tools in this menu. |
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.
Workspaces have moved - this text needs updating.
No description provided.