diff --git a/docs/index.md b/docs/index.md index 0136f8d48b..046ba3ede4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,15 +1,12 @@ Remix - Solidity IDE ==================== -Remix is an IDE for the smart contract programming language Solidity and +Remix is Ethereum IDE for the smart contract programming language Solidity and has an integrated debugger and testing environment. An up to date online version is available at [remix.ethereum.org](http://remix.ethereum.org) -This page will host documentation and tutorial about features Remix -provides. - Please go to [solidity.readthedocs.io](http://solidity.readthedocs.io) for any information regarding `Solidity` @@ -32,31 +29,29 @@ Remix is a good solution if you intend to: > - Together with Mist (or any tool which inject web3), Remix can be > used to test and debug a Dapp (see ../tutorial\_mist) -Developing smart contract requires a deep understanding of the +Developing smart contract requires deep understanding of the associated Blockchain technology. -!! Don't use Remix against a production network unless you are -completely sure what you are doing !! - -This documentation describes all the features remix provides. The GUI -can be separated in 4 parts. Click on one the link to get more -information. - -> - ../file\_explorer -> - ../solidity\_editor -> - ../terminal -> - ../tabs\_panel -> : - ../compile\_tab -> - ../run\_tab -> - ../settings\_tab -> - ../debugger\_tab -> - ../analysis\_tab -> - ../support\_tab -> -Quick Start ------------ - -(see ../quickstart\_javascriptvm) - -Tutorial --------- +Contents +======== + +:ref:`Keyword Index `, :ref:`Search Page ` + +.. toctree:: + :maxdepth: 2 + + quickstart_javascript_vm.md + file_explorer.md + solidity_editor.md + compile_tab.md + run_tab.md + terminal.md + debugger_tab.md + analysis_tab.md + settings_tab.md + support_tab.md + workshop_Building_smart_contracts_with_Remix.md + tutorial_debug.md + tutorial_import.md + tutorial_connect_remix_with_your_filesystem.md + tutorial_mist.md diff --git a/docs/quickstart_javascriptvm.md b/docs/quickstart_javascript_vm.md similarity index 100% rename from docs/quickstart_javascriptvm.md rename to docs/quickstart_javascript_vm.md diff --git a/docs/tabs_panel.md b/docs/tabs_panel.md deleted file mode 100644 index 39c452cac0..0000000000 --- a/docs/tabs_panel.md +++ /dev/null @@ -1,10 +0,0 @@ -Tabs Panel -========== - -- ../compile\_tab -- ../run\_tab -- ../settings\_tab -- ../debugger\_tab -- ../analysis\_tab -- ../support\_tab - diff --git a/docs/tutorial_remixd_filesystem.md b/docs/tutorial_connect_remix_with_your_filesystem.md similarity index 96% rename from docs/tutorial_remixd_filesystem.md rename to docs/tutorial_connect_remix_with_your_filesystem.md index 6ffaffa87a..48a217296c 100644 --- a/docs/tutorial_remixd_filesystem.md +++ b/docs/tutorial_connect_remix_with_your_filesystem.md @@ -1,4 +1,4 @@ -Accessing a shared folder in Remix IDE using Remixd +Access your local filesystem by using Remixd =================================================== Remixd is an npm module. Its purpose is to give the remix web diff --git a/docs/workshop_Building_smart_contracts_with_Remix.md b/docs/workshop_Building_smart_contracts_with_Remix.md new file mode 100644 index 0000000000..bbcd50af7a --- /dev/null +++ b/docs/workshop_Building_smart_contracts_with_Remix.md @@ -0,0 +1,8 @@ +Building Smart Contracts with Remix +======================= + +We prepared a thorough workshop that will help you build your own DApp. We will show you how to build and deploy smart contracts, how to deploy them and how to interact with them. Later in the workshop you will also learn how to connect your frontend with blockchain by using web3.js. + +### Let's get started + +To start with the workshop, please click [this link](https://slides.com/ninabreznik/deck-11-13#/)