Update docs in general

pull/7/head
ninabreznik 7 years ago
parent 37a120c82f
commit 6015d22e15
  1. 12
      docs/code_contribution_guide.md
  2. 15
      docs/conf.py
  3. 94
      docs/index.md
  4. 26
      docs/run_tab.md
  5. 9
      docs/support.md
  6. 23
      docs/udapp.md

@ -0,0 +1,12 @@
Code contribution guide
=======================
Remix is an open source tool and we encourage anyone to help us improve our tool.
You can do that by opening issues, giving feedback or by contributing a pull request
to our codebase.
Remix application is built with Javascript and it doesn't use any framework, we only
rely on selected set of NPM modules, like `yo-yo`, `csjs-inject` and others. Check out
package.json file to learn more about the stack.
To learn more, please visit our [Github page](https://github.com/ethereum/remix-ide).

@ -14,8 +14,6 @@
import sys import sys
import os import os
import recommonmark
from recommonmark.transform import AutoStructify
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the # add these directories to sys.path here. If the directory is relative to the
@ -39,12 +37,6 @@ templates_path = ['_templates']
# You can specify multiple suffix as a list of string: # You can specify multiple suffix as a list of string:
# source_suffix = ['.rst', '.md'] # source_suffix = ['.rst', '.md']
from recommonmark.parser import CommonMarkParser
source_parsers = {
'.md': CommonMarkParser,
}
source_suffix = ['.rst', '.md'] source_suffix = ['.rst', '.md']
# The encoding of source files. # The encoding of source files.
@ -293,10 +285,3 @@ texinfo_documents = [
# If true, do not generate a @detailmenu in the "Top" node's menu. # If true, do not generate a @detailmenu in the "Top" node's menu.
#texinfo_no_detailmenu = False #texinfo_no_detailmenu = False
def setup(app):
app.add_config_value('recommonmark_config', {
'url_resolver': lambda url: github_doc_root + url,
'auto_toc_tree_section': 'Contents',
}, True)
app.add_transform(AutoStructify)

@ -1,46 +1,74 @@
Remix: Ethereum - IDE Welcome to Remix documentation!
==================== ===============================
## Welcome! Remix is a powerful, open source tool that helps you write Solidity contracts straight from the browser.
REMIX is a tool that can help you more efficiently **write, test, debug Written in Javascript, Remix supports both usage in the browser or locally.
and deploy Solidity contracts** directly from the browser. No signup needed. Just open [the link](http://remix.ethereum.org) and get started. It works best in Chrome and/or Firefox.
## Useful links Remix also supports testing, debugging and deploying of smart contracts and much more.
If you are new to blockchain and Ethereum ecosystem, this is a set of recommended resources and links to help you start with building your smart contracts:
* [REMIX: Ethereum IDE](http://remix.ethereum.org) Our Remix project with all its features is available
* [Documentation about Solidity language](https://solidity.readthedocs.io) at `http://remix.ethereum.org` and more information can be found in these
* [Remix support/community chat](https://gitter.im/ethereum/remix) docs. Our tool is available at `our GitHub repository
* [Remix Github repository](https://github.com/ethereum/remix-ide) <https://github.com/ethereum/remix-id>`__.
## Getting started This set of documents covers instructions on how to use Remix and some tutorials to help you get started.
To see how Remix works and how you can build your first simple contract, [click
here to get started!](quickstart_javascript_vm.md)
-------- Contents:
* :ref:`quick start`
* :ref:`deploy and test`
* :ref:`other remix features`
* :ref:`tutorials and workshops`
* :ref:`code contribution guide`
.. quick-start:
Contents .. toctree::
======== :maxdepth: 2
:caption: Quick start
solidity_editor
compile_tab
quickstart_javascript_vm
.. deploy and test:
.. toctree::
:maxdepth: 2
:caption: Deploy and test
run_tab
udapp
.. _other-remix-features:
.. toctree::
:maxdepth: 2
:caption: Other Remix features
file_explorer
debugger_tab
analysis_tab
terminal
.. _tutorials and workshops:
.. toctree::
:maxdepth: 2
:caption: Tutorials and workshops
workshop_Building_smart_contracts_with_Remix
tutorial_connect_remix_with_your_filesystem
tutorial_debug
tutorial_import
tutorial_mist
:ref:`Keyword Index <genindex>`, :ref:`Search Page <search>` .. _code-contribution-guide:
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Code contribution guide
quickstart_javascript_vm.md code_contribution_guide
file_explorer.md support
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

@ -57,34 +57,10 @@ shows it in a pending mode. When transaction is mined the number of
pending transactions is updated and the transaction is added to the log pending transactions is updated and the transaction is added to the log
(see ../terminal) (see ../terminal)
Instance List
-------------
This section contains a 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 it does not
create a new transaction. Clicking it is not necessary because
there are not state changes - but it 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 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.
USING ABI USING ABI
--------- ---------
Using `Create` or `At Address` is a classic use case of Remix. It is Using `Deploy` or `At Address` is a classic use case of Remix. It is
possible though to interact with a contract by using its ABI. The ABI is possible though to interact with a contract by using its ABI. The ABI is
a JSON array which describe its interface. a JSON array which describe its interface.

@ -0,0 +1,9 @@
Support chat
=======================
We know that blockchain ecosystem is very new and that lots of information is scattered around the web.
That is why we created a community support chat where we and other users try to answer your questions if
you get stuck using Remix. Please, join [the chat](https://gitter.im/ethereum/remix) and ask community for help.
For anyone who is interested in developing a custom plugin for Remix or who wants to contribute to the codebase,
we opened [another channel](https://gitter.im/ethereum/remix-dev) specially for developers working on Remix tool.

@ -0,0 +1,23 @@
Deployed contracts
====================
This section in the Run tab contains a list of deployed contracts to interact with through autogenerated UI of the deployed contract (also called udapp).
Several cases apply:
: - The called function is declared as `constant` or `pure` in
Solidity. The action has a blue background, clicking it does not
create a new transaction. Clicking it is not necessary because
there are not state changes - but it 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 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.
Loading…
Cancel
Save