cerc-io/solidity
10
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #9968 from ethereum/docs_fixes

Browse Source 
[Docs] Updates Index/Home Page of Sol Docs / Adds "Getting Started"
This commit is contained in:
Harikrishnan Mulackal 2020-10-12 08:54:31 +02:00 committed by GitHub
commit 8f2cd82fd9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 36 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
docs/index.rst
View File

@ -26,42 +26,58 @@ a 0.x version number `to indicate this fast pace of change <https://semver.org/#
.. warning:: .. warning::
Solidity recently released the 0.6.x version that introduced a lot of breaking Solidity recently released the 0.7.x version that introduced a lot of breaking
changes. Make sure you read :doc:`the full list <060-breaking-changes>`. changes. Make sure you read :doc:`the full list <070-breaking-changes>`.
Language Documentation Ideas for improving Solidity or this documentation are always welcome,
---------------------- read our :doc:`contributors guide <contributing>` for more details.
If you are new to the concept of smart contracts we recommend you start with Getting Started
:ref:`an example smart contract <simple-smart-contract>` written ---------------
in Solidity. When you are ready for more detail, we recommend you read the
:doc:`"Solidity by Example" <solidity-by-example>` and
"Language Description" sections to learn the core concepts of the language.
For further reading, try :ref:`the basics of blockchains <blockchain-basics>` **1. Understand the Smart Contract Basics**
and details of the :ref:`Ethereum Virtual Machine <the-ethereum-virtual-machine>`.
If you are new to the concept of smart contracts we recommend you to get started by digging
into the "Introduction to Smart Contracts" section, which covers:
* :ref:`A simple example smart contract <simple-smart-contract>` written in Solidity.
* :ref:`Blockchain Basics <blockchain-basics>`.
* :ref:`The Ethereum Virtual Machine <the-ethereum-virtual-machine>`.
**2. Get to Know Solidity**
Once you are accustomed to the basics, we recommend you read the :doc:`"Solidity by Example" <solidity-by-example>`
and “Language Description” sections to understand the core concepts of the language.
**3. Install the Solidity Compiler**
There are various ways to install the Solidity compiler,
simply choose your preferred option and follow the steps outlined on the :ref:`installation page <installing-solidity>`.
.. hint:: .. hint::
You can always try out code examples in your browser with the You can try out code examples directly in your browser with the
`Remix IDE <https://remix.ethereum.org>`_. Remix is a web browser based IDE `Remix IDE <https://remix.ethereum.org>`_. Remix is a web browser based IDE
that allows you to write Solidity smart contracts, then deploy and run the that allows you to write, deploy and administer Solidity smart contracts, without
smart contracts. It can take a while to load, so please be patient. the need to install Solidity locally.
.. warning:: .. warning::
As humans write software, it can have bugs. You should follow established As humans write software, it can have bugs. You should follow established
software development best-practices when writing your smart contracts, this software development best-practices when writing your smart contracts. This
includes code review, testing, audits, and correctness proofs. Smart contract includes code review, testing, audits, and correctness proofs. Smart contract
users are sometimes more confident with code than their authors, and users are sometimes more confident with code than their authors, and
blockchains and smart contracts have their own unique issues to blockchains and smart contracts have their own unique issues to
watch out for, so before working on production code, make sure you read the watch out for, so before working on production code, make sure you read the
:ref:`security_considerations` section. :ref:`security_considerations` section.
If you have any questions, you can try searching for answers or asking on the **4. Learn More**
`Ethereum Stackexchange <https://ethereum.stackexchange.com/>`_, or
our `gitter channel <https://gitter.im/ethereum/solidity/>`_.
Ideas for improving Solidity or this documentation are always welcome, If you want to learn more about building decentralized applications on Ethereum, the
read our :doc:`contributors guide <contributing>` for more details. `Ethereum Developer Resources <https://ethereum.org/en/developers/>`_
can help you with further general documentation around Ethereum, and a wide selection of tutorials,
tools and development frameworks.
If you have any questions, you can try searching for answers or asking on the
`Ethereum StackExchange <https://ethereum.stackexchange.com/>`_, or
our `Gitter channel <https://gitter.im/ethereum/solidity/>`_.
.. _translations: .. _translations: