Merge pull request #13911 from ethereum/fix-broken-docs-links-and-redirects

Fix broken docs links and redirects
This commit is contained in:
Kamil Śliwak 2023-02-01 14:13:31 +01:00 committed by GitHub
commit 37953a7eb0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 16 additions and 16 deletions

View File

@ -8,7 +8,7 @@ Contracts can be created "from outside" via Ethereum transactions or from within
IDEs, such as `Remix <https://remix.ethereum.org/>`_, make the creation process seamless using UI elements.
One way to create contracts programmatically on Ethereum is via the JavaScript API `web3.js <https://github.com/ethereum/web3.js>`_.
One way to create contracts programmatically on Ethereum is via the JavaScript API `web3.js <https://github.com/web3/web3.js>`_.
It has a function called `web3.eth.Contract <https://web3js.readthedocs.io/en/1.0/web3-eth-contract.html#new-contract>`_
to facilitate contract creation.

View File

@ -151,6 +151,6 @@ The output of the above looks like the following (trimmed):
Additional Resources for Understanding Events
=============================================
- `Javascript documentation <https://github.com/ethereum/web3.js/blob/1.x/docs/web3-eth-contract.rst#events>`_
- `Javascript documentation <https://github.com/web3/web3.js/blob/1.x/docs/web3-eth-contract.rst#events>`_
- `Example usage of events <https://github.com/ethchange/smart-exchange/blob/master/lib/contracts/SmartExchange.sol>`_
- `How to access them in js <https://github.com/ethchange/smart-exchange/blob/master/lib/exchange_transactions.js>`_

View File

@ -102,9 +102,9 @@ This can be easiest accomplished using Homebrew: ``brew install coreutils``.
On Windows systems, make sure that you have a privilege to create symlinks,
otherwise several tests may fail.
Administrators should have that privilege, but you may also
`grant it to other users <https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links#policy-management>`_
`grant it to other users <https://learn.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/create-symbolic-links#policy-management>`_
or
`enable Developer Mode <https://docs.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development>`_.
`enable Developer Mode <https://learn.microsoft.com/en-us/windows/apps/get-started/enable-your-device-for-development>`_.
Running the Tests
-----------------
@ -408,7 +408,7 @@ local slang and references, making your language as clear to all readers as poss
* `Simplified technical English <https://en.wikipedia.org/wiki/Simplified_Technical_English>`_
* `International English <https://en.wikipedia.org/wiki/International_English>`_
* `British English spelling <https://en.oxforddictionaries.com/spelling/british-and-spelling>`_
* `British English spelling <https://web.archive.org/web/20220324094038/https://www.lexico.com/grammar/british-and-spelling>`_
.. note::

View File

@ -36,7 +36,7 @@ Creating the signature
Alice does not need to interact with the Ethereum network
to sign the transaction, the process is completely offline.
In this tutorial, we will sign messages in the browser
using `web3.js <https://github.com/ethereum/web3.js>`_ and
using `web3.js <https://github.com/web3/web3.js>`_ and
`MetaMask <https://metamask.io>`_, using the method described in `EIP-712 <https://github.com/ethereum/EIPs/pull/712>`_,
as it provides a number of other security benefits.

View File

@ -95,7 +95,7 @@ version stands as a reference.
You can switch between languages by clicking on the flyout menu in the bottom-left corner
and selecting the preferred language.
* `Chinese <https://github.com/solidity-docs/zh-cn-chinese/>`_
* `Chinese <https://docs.soliditylang.org/zh/latest/>`_
* `French <https://docs.soliditylang.org/fr/latest/>`_
* `Indonesian <https://github.com/solidity-docs/id-indonesian>`_
* `Japanese <https://github.com/solidity-docs/ja-japanese>`_
@ -103,7 +103,7 @@ and selecting the preferred language.
* `Persian <https://github.com/solidity-docs/fa-persian>`_
* `Russian <https://github.com/solidity-docs/ru-russian>`_
* `Spanish <https://github.com/solidity-docs/es-spanish>`_
* `Turkish <https://github.com/solidity-docs/tr-turkish>`_
* `Turkish <https://docs.soliditylang.org/tr/latest/>`_
.. note::

View File

@ -185,7 +185,7 @@ arguments ``from``, ``to`` and ``amount``, which makes it possible to track
transactions.
To listen for this event, you could use the following
JavaScript code, which uses `web3.js <https://github.com/ethereum/web3.js/>`_ to create the ``Coin`` contract object,
JavaScript code, which uses `web3.js <https://github.com/web3/web3.js/>`_ to create the ``Coin`` contract object,
and any user interface calls the automatically generated ``balances`` function from above:
.. code-block:: javascript

View File

@ -182,7 +182,7 @@ Syntax and Semantics
Solidity supports import statements to help modularise your code that
are similar to those available in JavaScript
(from ES6 on). However, Solidity does not support the concept of
a `default export <https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export#Description>`_.
a `default export <https://developer.mozilla.org/en-US/docs/web/javascript/reference/statements/export#description>`_.
At a global level, you can use import statements of the following form:

View File

@ -46,7 +46,7 @@ for the purposes of NatSpec.
- For Vyper, use ``"""`` indented to the inner contents with bare
comments. See the `Vyper
documentation <https://vyper.readthedocs.io/en/latest/natspec.html>`__.
documentation <https://docs.vyperlang.org/en/latest/natspec.html>`__.
The following example shows a contract and a function using all available tags.

View File

@ -28,7 +28,7 @@ Integrated (Ethereum) Development Environments
* `Embark <https://framework.embarklabs.io/>`_
Developer platform for building and deploying decentralized applications.
* `Foundry <https://github.com/gakonst/foundry>`_
* `Foundry <https://github.com/foundry-rs/foundry>`_
Fast, portable and modular toolkit for Ethereum application development written in Rust.
* `Hardhat <https://hardhat.org/>`_
@ -37,7 +37,7 @@ Integrated (Ethereum) Development Environments
* `Remix <https://remix.ethereum.org/>`_
Browser-based IDE with integrated compiler and Solidity runtime environment without server-side components.
* `Truffle <https://www.trufflesuite.com/truffle>`_
* `Truffle <https://trufflesuite.com/truffle/>`_
Ethereum development framework.
Editor Integrations
@ -50,7 +50,7 @@ Editor Integrations
* IntelliJ
* `IntelliJ IDEA plugin <https://plugins.jetbrains.com/plugin/9475-intellij-solidity>`_
* `IntelliJ IDEA plugin <https://plugins.jetbrains.com/plugin/9475-solidity/>`_
Solidity plugin for IntelliJ IDEA (and all other JetBrains IDEs).
* Sublime Text

View File

@ -17,11 +17,11 @@ conflicts, project specific style guides take precedence.
The structure and many of the recommendations within this style guide were
taken from python's
`pep8 style guide <https://www.python.org/dev/peps/pep-0008/>`_.
`pep8 style guide <https://peps.python.org/pep-0008/>`_.
The goal of this guide is *not* to be the right way or the best way to write
Solidity code. The goal of this guide is *consistency*. A quote from python's
`pep8 <https://www.python.org/dev/peps/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds>`_
`pep8 <https://peps.python.org/pep-0008/#a-foolish-consistency-is-the-hobgoblin-of-little-minds>`_
captures this concept well.
.. note::