update docs and remove old images

Joker7L · Jun 13, 2019 · 93ddc08 · 93ddc08
1 parent 478b411
commit 93ddc08
Show file tree

Hide file tree

Showing 92 changed files with 145 additions and 211 deletions.
diff --git a/docs/_build/doctrees/code_contribution_guide.doctree b/docs/_build/doctrees/code_contribution_guide.doctree
diff --git a/docs/_build/doctrees/community.doctree b/docs/_build/doctrees/community.doctree
diff --git a/docs/_build/doctrees/compile.doctree b/docs/_build/doctrees/compile.doctree
diff --git a/docs/_build/doctrees/contract_metadata.doctree b/docs/_build/doctrees/contract_metadata.doctree
diff --git a/docs/_build/doctrees/create_deploy.doctree b/docs/_build/doctrees/create_deploy.doctree
diff --git a/docs/_build/doctrees/debugger.doctree b/docs/_build/doctrees/debugger.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/file_explorer.doctree b/docs/_build/doctrees/file_explorer.doctree
diff --git a/docs/_build/doctrees/import.doctree b/docs/_build/doctrees/import.doctree
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/layout.doctree b/docs/_build/doctrees/layout.doctree
diff --git a/docs/_build/doctrees/locations.doctree b/docs/_build/doctrees/locations.doctree
diff --git a/docs/_build/doctrees/plugin_manager.doctree b/docs/_build/doctrees/plugin_manager.doctree
diff --git a/docs/_build/doctrees/remix_plugin.doctree b/docs/_build/doctrees/remix_plugin.doctree
diff --git a/docs/_build/doctrees/remix_plugin_api.doctree b/docs/_build/doctrees/remix_plugin_api.doctree
diff --git a/docs/_build/doctrees/remix_tutorials_github.doctree b/docs/_build/doctrees/remix_tutorials_github.doctree
diff --git a/docs/_build/doctrees/remixd.doctree b/docs/_build/doctrees/remixd.doctree
diff --git a/docs/_build/doctrees/run.doctree b/docs/_build/doctrees/run.doctree
diff --git a/docs/_build/doctrees/settings.doctree b/docs/_build/doctrees/settings.doctree
diff --git a/docs/_build/doctrees/solidity_editor.doctree b/docs/_build/doctrees/solidity_editor.doctree
diff --git a/docs/_build/doctrees/static_analysis.doctree b/docs/_build/doctrees/static_analysis.doctree
diff --git a/docs/_build/doctrees/support.doctree b/docs/_build/doctrees/support.doctree
diff --git a/docs/_build/doctrees/terminal.doctree b/docs/_build/doctrees/terminal.doctree
diff --git a/docs/_build/doctrees/tutorial_debug.doctree b/docs/_build/doctrees/tutorial_debug.doctree
diff --git a/docs/_build/doctrees/tutorial_geth-remix.doctree b/docs/_build/doctrees/tutorial_geth-remix.doctree
diff --git a/docs/_build/doctrees/udapp.doctree b/docs/_build/doctrees/udapp.doctree
diff --git a/docs/_build/doctrees/unittesting.doctree b/docs/_build/doctrees/unittesting.doctree
diff --git a/docs/_build/html/_images/a-debug6-term-txn-hash.png b/docs/_build/html/_images/a-debug6-term-txn-hash.png
diff --git a/docs/_build/html/_images/a-debug7-debugger.png b/docs/_build/html/_images/a-debug7-debugger.png
diff --git a/docs/_build/html/_images/a-debug8-top3.png b/docs/_build/html/_images/a-debug8-top3.png
diff --git a/docs/_build/html/_images/a-debug9-buttons.png b/docs/_build/html/_images/a-debug9-buttons.png
diff --git a/docs/_build/html/_images/a-layout1c.png b/docs/_build/html/_images/a-layout1c.png
diff --git a/docs/_build/html/_sources/layout.md.txt b/docs/_build/html/_sources/layout.md.txt
@@ -3,10 +3,10 @@ Remix-IDE Layout
 
 The new structure
 --------------------
-![](images/a-layout1b.png)
+![](images/a-layout1c.png)
 
-1. Icon Panel - click to change which plugin appears in the Swap Panel
-2. Swap Panel - Most but not all plugins will have their GUI here.
+1. Icon Panel - click to change which plugin appears in the Side Panel
+2. Side Panel - Most but not all plugins will have their GUI here.
 3. Main Panel - In the old layout this was just for editing files.  In the tabs can be plugins or files for the IDE to compile.
 4. Terminal - where you will see the results of your interactions with the GUI's.  Also you can run scripts here.
 

diff --git a/docs/_build/html/_sources/remixd.md.txt b/docs/_build/html/_sources/remixd.md.txt
@@ -10,14 +10,17 @@ The code of `remixd` is
 `remixd` can be globally installed using the following command:
 `npm install -g remixd`
 
-You can install it just in the directory of your choice using this command:
+Or just install it in the directory of your choice by removing the -g flag:
 `npm install remixd`
 
-Then `remixd -s <absolute-path-to-the-shared-folder> --remix-ide <your-remix-ide-URL-instance>` will start `remixd` and will share the given folder. 
+Then from the terminal, the command `remixd -s <absolute-path-to-the-shared-folder> --remix-ide <your-remix-ide-URL-instance>` will start `remixd` and will share the given folder with remix-ide. 
 
-For example, to sync your local folder to the official Remix IDE, 
+For example, to use remixd with Remix IDE ( and not the alpha version) use this command: 
 `remixd -s <absolute-path-to-the-shared-folder> --remix-ide https://remix.ethereum.org`
 
+Make sure that if you use https://remix.ethereum.org (secure http) in the remixd command (like in the example above), that you are also pointing your browser to https://remix.ethereum.org and not to http://remix.ethereum.org (plain old insecure http).  Or if you want to use http in the browser use http in the remixd command.
+
+
 The folder is shared using a websocket connection between `Remix IDE`
 and `remixd`.
 

diff --git a/docs/_build/html/_sources/tutorial_debug.md.txt b/docs/_build/html/_sources/tutorial_debug.md.txt
@@ -2,19 +2,17 @@ Debugging transactions
 ======================
 
 There are two ways to start debugging, each one corresponds to a different use case.
-* from the transaction log in the Terminal - use this when you are want to debug a "sucessful" transaction.
-* from the Debugger - use this if you have a *transaction hash* or a *block number* with a *transaction index*.
+* from the transaction log in the Terminal - use this when you want to debug a transaction.
+* from the Debugger - use this if you have a *transaction hash*.
 
-### Debug from the Transaction GUI - 
-
-Let's start with a basic contract (or replace this one by your own):
+### Initiate Debugging from the transaction log in the Terminal
+Let's start with a basic contract ( or replace this one by your own ) :
 - create a blank file in the file explorer (by clicking the + icon) and give it a name.
 - copy the code below.
 - compile the code.
 - click the Run & Deploy icon in the icon panel.
 
 ``` 
-{.sourceCode .none}  - RS why is this here?
 pragma solidity >=0.5.1 <0.6.0;
 contract Donation {
     address owner;
@@ -90,51 +88,49 @@ Click the debug button to start debugging it.
 
 ![](images/a-debug5-term-debug-but.png)
 
-### From the Debugger
+Before we get to the actual debugging tool, the next section show how to start debugging session directly from the Debugger.
+
+### Initiate Debugging from the from the Debugger
+
+Click the bug icon in the icon panel to get to the debugger in the side panel.  
 
-Click the bug icon in the icon panel to get to the debugger in the side panel.  If you don't see the bug icon go to the plugin manager and activate the debugger.
+If you don't see the bug icon, go to the plugin manager and activate the debugger.
 
-You can start a debug session by providing either a `transaction hash`
-or a `block number` and `transaction index`.
+You can start a debug session by providing a `transaction hash`.
 
-To find a transaction hash 
-1. go to a transaction in the terminal.
+To find a transaction hash: 
+1. Go to a transaction in the terminal. 
 2. Click a line with a transaction - to exand the log.
-3. Copy the transaction has locate there.
+3. The transaction hash is there - copy it.
 
-![image](remix3.png)
+![](images/a-debug6-term-txn-hash.png)
 
-Then click on the `start debugging` button.
+Then click in the debugger paste the hash and click on the `Start debugging` button.
+
+![](images/a-debug7-debugger.png)
 
 Using the debugger
 ------------------
 
+![](images/a-debug8-top3.png)
+
 The debugger allows one to see detailed informations about the
 transaction's execution. It uses the editor to display the
 location in the source code where the current execution is.
 
-The transaction panel displays basic information about the current
-transaction.
-
-![image](remix_debugtransactioninfo.png)
-
 The navigation part contains a slider and buttons that can be used to
 step through the transaction execution.
 
-From the left to the right:
 
-step over back, step into back, step into forward, step over forward,
-jump out (jump out of the current call), jump to the previous
-breakpoint, jump to the next breakpoint.
+### More explaination of what these buttons do.
+1. Step Into
+2. Step Over Into
 
-![image](remix_navigation.png)
 
 11 panels give detailed information about the execution:
 
 ### Instructions
 
-![image](remix_debuginstructions.png)
-
 The Instructions panel displays the bytecode of the current executing
 contract- with the current step highlighted.
 
@@ -146,15 +142,11 @@ those that refers to the same expression.
 
 ### Solidity Locals
 
-![image](remix_soliditylocals.png)
-
 The Solidity Locals panel displays local variables associated with the
 current context.
 
 ### Solidity State
 
-![image](remix_soliditystate.png)
-
 The Solidity State panel displays state variables of the current
 executing contract.
 
@@ -173,7 +165,7 @@ These panels display low level informations about the execution:
 
 ### Reverted Transaction
 
-A transaction could be `reverted` (because of an *out of gas exception* or
+A transaction can be `reverted` (because of an *out of gas exception* or
 Solidity `revert` statement or because of a low level exception).
 
 It is important to be aware of the exception and to locate
@@ -183,17 +175,13 @@ Remix will warn you when the execution throws an exception. The
 `warning` button will jump to the last opcode before the exception
 happened.
 
-![image](remix_executionexception.png)
-
 ### Breakpoints
 
 The two last buttons from the navigation area are used to jump either
 back to the previous breakpoint or forward to the next breakpoint.
 
 Breakpoints can be added and removed by clicking on the line number in the *Editor*.
 
-![image](remix_breakpoint.png)
-
 When using debug session with breakpoints, the execution will jump to the first
 encountered breakpoint.
 
@@ -202,9 +190,7 @@ variable, it might be triggered twice: Once for initializing the
 variable to zero and second time for assigning the actual value. As an
 example, assume you are debugging the following contract:
 
-(RS - what is the {.sourceCode .none} doing?)
 ``` 
-{.sourceCode .none}
 pragma solidity >=0.5.1 <0.6.0;
 
 contract ctr {

diff --git a/docs/_build/html/_sources/udapp.md.txt b/docs/_build/html/_sources/udapp.md.txt
@@ -29,23 +29,28 @@ For more information see more about [Solidity
 modifier](http://solidity.readthedocs.io/en/develop/miscellaneous.html?highlight=pure#modifiers)
 .
 
-If a function requires input parameters, well, you have to put them in.
+If a function requires input parameters, well.. you gotta put them in.
 
 ## Inputting parameters
 
 ![](images/a-udapp-inputs.png)
 
-The input box tells you what type each parameter needs to be.
+### Inputting parameters in the collapsed view
 
-Numbers and addresses do not need to be wrapped in double quotes.  Strings need to be wrapped.
+(Inputting all the parameters in a single input box)
++ The input box tells you what type each parameter needs to be.
++ Numbers and addresses do not need to be wrapped in double quotes.  
++ Strings need to be wrapped.
++ Parameters are separated by commas.
 
-When using the input box for parameters in its "up" display, the parameters need to be separated by a comma.  In the example above the "delegate" function has 3 parameters.
+In the example above the "delegate" function has 3 parameters.
 
-Clicking the 'down' caret brings you to the *Multi-param Manager* - where you can input the parameters one at a time. 
+### Inputting parameters in the expanded view
+Clicking the 'down' caret brings you to the *Multi-param Manager* - where you can input the parameters one at a time. **Much less confusing!**
 
 ![](images/a-udapp-multi-param-man.png)
 
-In the *Multi-param Manager*, strings do not need to be wrapped.  
+In the expanded view, strings do not need to be wrapped.  
 
 Clicking the clipboard icon will encode the inputs and will copy them.  Only a valid set of inputs can be encoded.  
 

diff --git a/docs/_build/html/layout.html b/docs/_build/html/layout.html
@@ -207,10 +207,10 @@
 <h1>Remix-IDE Layout<a class="headerlink" href="#remix-ide-layout" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="the-new-structure">
 <h2>The new structure<a class="headerlink" href="#the-new-structure" title="Permalink to this headline">¶</a></h2>
-<p><img alt="_images/a-layout1b.png" src="_images/a-layout1b.png" /></p>
+<p><img alt="_images/a-layout1c.png" src="_images/a-layout1c.png" /></p>
 <ol class="simple">
-<li><p>Icon Panel - click to change which plugin appears in the Swap Panel</p></li>
-<li><p>Swap Panel - Most but not all plugins will have their GUI here.</p></li>
+<li><p>Icon Panel - click to change which plugin appears in the Side Panel</p></li>
+<li><p>Side Panel - Most but not all plugins will have their GUI here.</p></li>
 <li><p>Main Panel - In the old layout this was just for editing files.  In the tabs can be plugins or files for the IDE to compile.</p></li>
 <li><p>Terminal - where you will see the results of your interactions with the GUI’s.  Also you can run scripts here.</p></li>
 </ol>

diff --git a/docs/_build/html/remixd.html b/docs/_build/html/remixd.html
@@ -201,11 +201,12 @@ <h1>Remixd: Get access your local filesystem<a class="headerlink" href="#remixd-
 <a class="reference external" href="https://github.com/ethereum/remixd">here</a> .</p>
 <p><code class="docutils literal notranslate"><span class="pre">remixd</span></code> can be globally installed using the following command:
 <code class="docutils literal notranslate"><span class="pre">npm</span> <span class="pre">install</span> <span class="pre">-g</span> <span class="pre">remixd</span></code></p>
-<p>You can install it just in the directory of your choice using this command:
+<p>Or just install it in the directory of your choice by removing the -g flag:
 <code class="docutils literal notranslate"><span class="pre">npm</span> <span class="pre">install</span> <span class="pre">remixd</span></code></p>
-<p>Then <code class="docutils literal notranslate"><span class="pre">remixd</span> <span class="pre">-s</span> <span class="pre">&lt;absolute-path-to-the-shared-folder&gt;</span> <span class="pre">--remix-ide</span> <span class="pre">&lt;your-remix-ide-URL-instance&gt;</span></code> will start <code class="docutils literal notranslate"><span class="pre">remixd</span></code> and will share the given folder.</p>
-<p>For example, to sync your local folder to the official Remix IDE,
+<p>Then from the terminal, the command <code class="docutils literal notranslate"><span class="pre">remixd</span> <span class="pre">-s</span> <span class="pre">&lt;absolute-path-to-the-shared-folder&gt;</span> <span class="pre">--remix-ide</span> <span class="pre">&lt;your-remix-ide-URL-instance&gt;</span></code> will start <code class="docutils literal notranslate"><span class="pre">remixd</span></code> and will share the given folder with remix-ide.</p>
+<p>For example, to use remixd with Remix IDE ( and not the alpha version) use this command:
 <code class="docutils literal notranslate"><span class="pre">remixd</span> <span class="pre">-s</span> <span class="pre">&lt;absolute-path-to-the-shared-folder&gt;</span> <span class="pre">--remix-ide</span> <span class="pre">https://remix.ethereum.org</span></code></p>
+<p>Make sure that if you use https://remix.ethereum.org (secure http) in the remixd command (like in the example above), that you are also pointing your browser to https://remix.ethereum.org and not to http://remix.ethereum.org (plain old insecure http).  Or if you want to use http in the browser use http in the remixd command.</p>
 <p>The folder is shared using a websocket connection between <code class="docutils literal notranslate"><span class="pre">Remix</span> <span class="pre">IDE</span></code>
 and <code class="docutils literal notranslate"><span class="pre">remixd</span></code>.</p>
 <p>Be sure the user executing <code class="docutils literal notranslate"><span class="pre">remixd</span></code> has read/write permission on the

diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js