Lectoring and adding images to the doc files

docs/analysis_tab.rst

@@ -1,10 +1,12 @@
 Analysis
 ========
 
-This section gives information about the last compilation. 
+This section gives information about the last compilation.
 A new analysis is by default run at each compilation.
 
-It gives detailed informations about the contract code and is a good way to avoid code mistakes and enforce best practices.
+It gives detailed information about the contract code and is a good way to avoid code mistakes and enforce best practices.
+
+.. image:: images/remix_analysistab.png
 
 Here the list of analyzers:
 
@@ -15,12 +17,11 @@ Here the list of analyzers:
         - Block timestamp: Semantics maybe unclear
         - Low level calls: Semantics maybe unclear
         - Block.blockhash usage: Semantics maybe unclear
-    
+
     - Gas & Economy:
         - Gas costs: Warn if the gas requirements of functions are too high
         - This on local calls: Invocation of local functions via this
-        
+
     - Miscellaneous:
         - Constant functions: Check for potentially constant functions
         - Similar variable names: Check if variable names are too similar
- 

docs/compile_tab.rst

@@ -2,18 +2,19 @@ Compiling contracts
 ===================
 
 By default Remix triggers a compilation each time the current file is changed or another file is selected.
-If the contract has a lot of dependencies and takes long to compile, it is possible to disable `autocompilation`.
+If the contract has a lot of dependencies and takes a long time to compile, it is possible to disable the `autocompilation`.
+
+.. image:: images/remix_compiletab.png
 
 After each compilation, a list is updated with all the newly compiled contracts.
 
-`Details` shows up a modal dialog displaying information related to current selected contract.
+`Details` modal dialog displays detailed information about the current selected contract.
 
-It is possible to publish contract to Swarm (only non abstract contract can be published). 
+From this tab, you can also publish your contract to Swarm (only non abstract contract can be published).
 
-Published data contains notably the ``abi`` and solidity source code. 
+Published data contains notably the ``abi`` and solidity source code.
 
-After a contract is published, metadata information can be accessed using the `bzz` URL located in the details modal dialog ``SWARM LOCATION``.
+After a contract is published, you can find its metadata information using the `bzz` URL located in the details modal dialog ``SWARM LOCATION``.
 
-Compilation Errors and Warning are displayed below the contract section. At each compilation, the static analysis tab builds a report, it is very valuable to address reported issues even if the compiler seems not to complain.
+Compilation Errors and Warning are displayed below the contract section. At each compilation, the static analysis tab builds a report. It is very valuable to address reported issues even if the compiler doesn't complain.
 (see :doc:`../analysis_tab`)
- 

docs/debugger_tab.rst

@@ -1,10 +1,11 @@
 Debugging
 =========
 
-This module allows to debug transaction.
-It can be used to deploy transaction created from Remix and already mined transactions.
+This module allows you to debug the transaction.
+It can be used to deploy transactions created from Remix and already mined transactions.
 (debugging works only if the current environment provides needed features).
 
+.. image:: images/remix_debuggertab.png
+
 All informations about debugging are describing in the following link:
 :doc:`../tutorial_debug`
- 

docs/file_explorer.rst

@@ -1,35 +1,37 @@
 File Explorer
 =============
 
-The file explorer list by default all the files (under `browser`) stored in your browser. Files can be renamed, removed, added.
+The file explorer lists by default all the files stored in your browser. You can see them in the `browser` folder. You can always rename, remove or add new files to the file explorer.
 
-Note that clearing the browser storage will permanently delete all the solidity sources you wrote.
+.. image:: images/remix_file_explorer_browser.png
 
-A solution would be to use Remixd (see :doc:`../tutorial_remixd_filesystem`)
+Note that clearing the browser storage will permanently delete all the solidity sources you wrote. To avoid this, you can use Remixd, which enables you to store and sync files in the browser with your local files (for more information see :doc:`../tutorial_remixd_filesystem`)
+
+.. image:: images/remix_file_explorer_menu.png
 
 From the left to the right:
 
 Create new File
 ---------------
 
-This action will create a new file in the `browser` explorer.
+Creates a new file in the `browser` explorer.
 
 Add Local File
 --------------
 
-This allows to select files from the filesystem and import them to the remix browser storage.
+Allows you to select files from the local file system and import them to the Remix browser storage.
 
 Publish to Gist
 ---------------
 
-This allows to publish files from the browser storage to an anonymous public gist.
+Publishes files from the browser storage to an anonymous public gist.
 
 Copy to another instance
 ------------------------
 
-This allows to copy files from the browser storage to another instance (URL) of Remix.
+Enables you to copy files from the browser storage to another instance (URL) of Remix.
 
 Connect to Localhost
 --------------------
 
-This allows to use file located in your file system (see :doc:`../tutorial_remixd_filesystem`).
+Allows to use file located in your file system (see :doc:`../tutorial_remixd_filesystem`).

docs/run_tab.rst

@@ -1,25 +1,28 @@
 Running transactions
 ====================
 
-This tab is an important section of Remix, it allows sending transactions to the current environment.
+This tab is an important section of Remix. It allows you to send transactions to the current environment.
+
+.. image:: images/remix_runtab.png
 
 Run Setup
 ---------
 
-this includes settings that are direclty relevant to transaction execution:
+These are the settings that enables you to directly influence the transaction execution:
 
  - Environment:
-    - ``JavaScript VM``: All the transactions are executed in a sandbox blockchain in the browser. That means nothing is persisted and a page reload will restart a new blockchain from scratch, the old one will not be saved
-    
-    - ``Injected Provider``: Remix will connect to an injected web3 provider. ``Mist`` and ``Metamask`` are example of application that inject web3 and thus can be used with this option.
-    
-    - ``Web3 Provider``: Remix will connect to a remote node (an URL need to be provided). This provider can be geth, parity or any Ethereum client.
-    
+    - ``JavaScript VM``: All the transactions will be executed in a sandbox blockchain in the browser. That means nothing will be persisted and a page reload will restart a new blockchain from scratch, the old one will not be saved.
+
+    - ``Injected Provider``: Remix will connect to an injected web3 provider. ``Mist`` and ``Metamask`` are example of providers that inject web3, thus can be used with this option.
+
+    - ``Web3 Provider``: Remix will connect to a remote node. You will need to provide the URL address to the selected provider: geth, parity or any Ethereum client.
+
  - Account: list of accounts associated with the current environment (and their associated balances)
- - Gas Limit is the max amount of gas that can be set for all the transactions created in Remix.
- - Value is the amount of value set for the next to be created transaction (this value is always reset to 0 after each transaction execution).
- 
- 
+ - Gas Limit: maximum amount of gas that can be set for all the transactions created in Remix
+ - Value: amount of value for the next created transaction (this value is always reset to 0 after each transaction execution)
+
+ .. image:: images/remix_runtab_example.png
+
 Initiate Instance
 -----------------
 
@@ -42,11 +45,11 @@ This section contains list of instances to interact with.
 
 Several cases apply:
  - The called function is declared as ``constant`` or ``pure`` in Solidity. The action has a blue background, clicking on it does not create a new transaction. (this is not necessary because there is not state changes) but will update the return value of the function.
- 
+
  - The called function has no special keywords. The action has a light red background, clicking on does create a new transaction. But this transaction cannot accept any amount of Ether.
- 
+
  - The called function is declared as ``payable`` in Solidity. The action has a red background, clicking on it does create a new transaction and this transaction can accept value.
 
 For more information about Solidity modifier, see `Solidity modifier <http://solidity.readthedocs.io/en/develop/miscellaneous.html?highlight=pure#modifiers>`_ .
 
-If a function requires input parameters, it is required to specify them.
+If a function requires input parameters, it is required to specify them.

docs/settings_tab.rst

@@ -1,11 +1,13 @@
 Settings
 ========
 
-This section contains general settings:
-
- - It displays the current compiler version and allows to change to current version.
- - Define if the text should be wrapped in the editor.
- - Define if the compiler enables optimization during compilation. Enabling this option save execution gas.
- It is interesting to enable optimization for contracts ready to be deployed in production
- but could lead to some inconsistency when debugging such a contract. 
- 
+This section displays the current compiler version and allows to change to another version.
+
+.. image:: images/remix_settingstab.png
+
+Settings, available here:
+
+ - Text wrap: defines if the text in the editor should be wrapped.
+ - Enable optimization: defines if the compiler should enable optimization during compilation. Enabling this option saves execution gas.
+ It is useful to enable optimization for contracts ready to be deployed in production
+ but could lead to some inconsistency when debugging such a contract.

docs/solidity_editor.rst

@@ -1,10 +1,13 @@
 Solidity Editor
 ===============
 
-- This editor provides syntax highlighting mapped to solidity keywords.
+Remix editor triggers a compilation each time the current file is changed or another file is selected. It also provides syntax highlighting mapped to solidity keywords.
+
+.. image:: images/remix_editor.png
+
+Here's the list of some important features:
+
 - It display opened files as tabs.
-- Compilation Warning and Error are displayed in the gutter.
-- By default Remix triggers a compilation each time the current file is changed or another file is selected.
-- Remix saves the current file continously (5s after the last changes).
-- +/- on the top left corner increase/decrease the font size.
- 
+- Compilation Warning and Error are displayed in the gutter
+- Remix saves the current file continuously (5s after the last changes)
+- +/- on the top left corner enable you to increase/decrease the font size of the editor

docs/support_tab.rst

@@ -1,4 +1,6 @@
 Support
 =======
 
-This section provides a list of usefull links and an access to the  `Remix channel <http://gitter.im/ethereum/remix>`_
+This section provides a link to the Remix issues where users can report a bug or suggest a feature, other useful links and and it displays a `Remix developers' channel <http://gitter.im/ethereum/remix>`_
+
+.. image:: images/remix_supporttab.png

docs/terminal.rst

@@ -1,12 +1,14 @@
 Terminal
 ========
 
-The Terminal is used for several use cases:
+.. image:: images/remix_terminal.png
 
-- Integrates a JavaScript interpreter and the ``web3`` object. It is possible to execute JavaScript script which interacts with the current context. (note that ``web3`` is only available if the ``web provider`` or ``injected provider`` mode is selected)
+Features, available in the terminal:
 
-- Display important action made on the GUI like sending a new transaction.
+- It integrates a JavaScript interpreter and the ``web3`` object. It enables the execution of the JavaScript script which interacts with the current context. (note that ``web3`` is only available if the ``web provider`` or ``injected provider`` mode is selected).
 
-- Display transactions that are mined in the current context. It is possible to display all transactions or only transactions that refers to contract Remix knows (e.g transaction created from the remix GUI).
+- It displays important actions made while interacting with the Remix IDE (i.e. sending a new transaction).
 
-- Allows filtering and clearing the data.
+- It displays transactions that are mined in the current context. You can choose to display all transactions or only transactions that refers to the contracts Remix knows (e.g transaction created from the Remix IDE).
+
+- It allows searching for the data and clearing the logs from the terminal.