remix-project/docs/index.rst

Welcome to Remix documentation!
===============================

Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser.
Written in JavaScript, Remix supports both usage in the browser and locally.

Remix also supports testing, debugging and deploying of smart contracts and much more.

Our Remix project with all its features is available
at `remix.ethereum.org <http://remix.ethereum.org>`__ and more information can be found in these
docs.  Our IDE tool is available at `our GitHub repository
<https://github.com/ethereum/remix-ide>`__.

This set of documents covers instructions on how to use Remix and some tutorials to help you get started.

Useful links:

- `Solidity documentation <https://solidity.readthedocs.io>`__

- `Remix alpha <http://remix-alpha.ethereum.org>`__ - The version where we test new Remix release (not stable!).

- `Remix on Medium <https://medium.com/remix-ide>`__

- `Ethereum StackExchange for Remix <https://ethereum.stackexchange.com/questions/tagged/remix>`__

- `Community support channel <https://gitter.im/ethereum/remix>`__

- `Ðapp Developer resources (Ethereum wiki) <https://github.com/ethereum/wiki/wiki/Dapp-Developer-Resources>`__

.. toctree::
   :maxdepth: 2
   :caption: New Layout Intro

   layout

.. toctree::
   :maxdepth: 2
   :caption: Tour of default modules

   file_explorer
   plugin_manager
   settings
   solidity_editor
   terminal

.. toctree::
   :maxdepth: 2
   :caption: Tour of typical solidity modules

   compile
   run
   udapp
   debugger
   static_analysis

.. toctree::
   :maxdepth: 2
   :caption: Using Remix
   
   contract_metadata
   create_deploy
   tutorial_debug
   FAQ
   import
   remix_commands
   remixd
   unittesting
   assert_library
   
.. toctree::
   :maxdepth: 2
   :caption: Building Plugins

   remix_plugin.md

.. toctree::
   :maxdepth: 2
   :caption: URLs & Downloads

   locations

.. toctree::
   :maxdepth: 2
   :caption: Tutorials and workshops

   remix_tutorials_github

.. toctree::
   :maxdepth: 2
   :caption: Code contribution guide

   code_contribution_guide
   community
   support