Skip to content

Commit 126821b

Browse files
authored
Merge pull request #3244 from davidekete/fix-broken-links
Fix broken links
2 parents a7b0180 + ecaa13d commit 126821b

26 files changed

+82
-69
lines changed

docs/FAQ.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
`Ctrl+S`: Compiles the active Solidity file
2020

21-
`Ctrl+Shift+S`: Compiles a Solidity file and runs a script when the script is displayed in the editor.<br>(go [here](running_js_scripts.html#compile-a-contract-and-run-a-script-on-the-fly) for more info about this functionality)
21+
`Ctrl+Shift+S`: Compiles a Solidity file and runs a script when the script is displayed in the editor.<br>(go {ref}`here <running_js_scripts:compile a contract and run a script in one click>` for more info about this functionality)
2222

2323
`Ctrl+Shift+F` : Opens the File Explorer
2424

@@ -108,7 +108,7 @@ The input of initPeepToPeeps takes a struct. If you input
108108

109109
**Q:** Where do plugin developers go with their questions?
110110

111-
**A:** First, join our [Discord server](https://discord.gg/zUNteAzJs3) and then go to the development-plugin channel.
111+
**A:** First, join our [Discord server](https://discord.com/invite/zUNteAzJs3) and then go to the development-plugin channel.
112112

113113
### Analytics
114114

docs/community.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Community Support
22

3-
Do you have questions about Remix? Join our [Discord](https://discord.gg/nfv6ZYjAeP) server and get some help!
3+
Do you have questions about Remix? Join our [Discord](https://discord.com/invite/nfv6ZYjAeP) server and get some help!
44

55
We post announcements and tips on [Twitter](https://twitter.com/ethereumremix).
66

docs/compile.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,14 +60,14 @@ When you publish your metadata to IPFS and deploy your code to the mainnet or a
6060

6161
### Compile and Run script
6262

63-
The Compile and Run script button (**E. in fig. 1**) is for compiling and then immediately running a script. It's a time saver so that you can write some code, automatically run script that sets state of the contract - thus allowing you to quickly understand how the code is working. ([more about Compile & Run](running_js_scripts.html?#compile-a-contract-and-run-a-script-on-the-fly))
63+
The Compile and Run script button (**E. in fig. 1**) is for compiling and then immediately running a script. It's a time saver so that you can write some code, automatically run script that sets state of the contract - thus allowing you to quickly understand how the code is working. Learn {ref}`more about Compile and Run <running_js_scripts:compile a contract and run a script in one click>`.
6464

6565
### Compilation Errors and Warning
6666

6767
Compilation Errors and Warning are displayed below the contract section.
6868
At each compilation, the static analysis tab builds a report.
6969

70-
It is important to address reported issues even if the compiler doesn't complain. ([more about static analysis](static_analysis.html))
70+
It is important to address reported issues even if the compiler doesn't complain. ({doc}`more about static analysis </static_analysis>`)
7171

7272
## Advanced Compiler Configurations
7373

@@ -93,7 +93,7 @@ To see the name of the hard fork used in the current compilation, click the "Com
9393

9494
According to the Solidity Docs, "the optimizer tries to simplify complicated expressions, which reduces both code size and execution cost, i.e., it can reduce gas needed for contract deployment as well as for external calls made to the contract."
9595

96-
For recent versions of Solidity, it is [recommended to enable optimization](https://blog.soliditylang.org/2020/11/04/solidity-ama-1-recap/#why-do-you-think-people-are-generally-suspicious-of-the-optimizer-and-are-they-right-to-be).
96+
For recent versions of Solidity, it is [recommended to enable optimization](https://soliditylang.org/blog/2020/11/04/solidity-ama-1-recap/#:~:text=Why%20do%20you%20think%20people%20are%20generally%20suspicious%20of%20the%20optimizer%2C%20and%20are%20they%20right%20to%20be%3F).
9797

9898
To learn more about optimization, (**Q. in the fig 2**) visit the [Solidity docs on the optimizer](https://docs.soliditylang.org/en/latest/internals/optimizer.html).
9999

docs/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,10 @@
3030
# Add any Sphinx extension module names here, as strings. They can be
3131
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3232
# ones.
33-
extensions = ['myst_parser', 'sphinx_copybutton'] # required for sphinx v3.0.0
33+
extensions = ['myst_parser', 'sphinx_copybutton', 'sphinx.ext.autosectionlabel'] # required for sphinx v3.0.0
3434
copybutton_prompt_text = r">>> |\$ "
3535
copybutton_prompt_is_regexp = True
36+
autosectionlabel_prefix_document = True
3637

3738
# suppress warnings caused by non-consecutive header
3839
# see more details here https://myst-parser.readthedocs.io/en/latest/faq/index.html#suppress-warnings

docs/create_deploy.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Let's go through a basic workflow:
1414

1515
In the File Explorer, create a new file by clicking on the new file icon, and name it. The `.sol` is default extension in Remix, if a file is named without an extension, `.sol` will appended.
1616

17-
**NOTE:** For information about templates or workspaces, see the [File Explorer docs](file_explorer.html).
17+
**NOTE:** For information about templates or workspaces, see the {doc}`File Explorer docs </file_explorer>`.
1818

1919
In the editor, paste in the following contract into the empty file:
2020

@@ -53,13 +53,14 @@ When pasting in code, make sure you understand it before deploying or interactin
5353
With the contract above as the active tab in the Editor, compile the contract.
5454
A quick way to compile is to hit **ctrl + s**. You can also compile by going to the Solidity Compiler and clicking the compile button, or by right clicking a file in the File Explorer, or by clicking the play button at the top of the Editor.
5555

56-
**For More Info** see the docs on the [Solidity Compiler](compile.html).
56+
**For More Info** see the docs on the {doc}`Solidity Compiler </compile>`.
5757

5858
## Deploy the contract
5959

6060
Go to the **Deploy & Run Transactions** plugin.
6161

62-
At the top of this plugin is the Environment selectbox. Here you can choose where you want to deploy your contract. There are many choices. For more info about these options see [this section](run.html#environment) of the docs.
62+
63+
At the top of this plugin is the Environment selectbox. Here you can choose where you want to deploy your contract. There are many choices. For more info about these options see {ref}`this section <run:environment>` of the docs.
6364

6465
For a brief synopsis:
6566

docs/debugger.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ To start a debugging session either:
1212

1313
The debugger will highlight the relevant code in the Editor. If you want to go back to editing the code without the Debugger's highlights, then click the **Stop Debugging** button.
1414

15-
To learn more about how to use this tool go to the [Debugging Transactions](tutorial_debug.html) page.
15+
To learn more about how to use this tool go to the {doc}`Debugging Transactions </tutorial_debug>` page.
1616

1717
This page will go over the Debugger's _Use generated sources_ option, its navigation and its panels.
1818

1919
![](images/a-debugger-overview.png)
2020

2121
## Use generated sources
2222

23-
This option is available for contracts using Solidity 0.7.2 or greater. See the solidity blog for more details about [generated sources](https://blog.soliditylang.org/2020/09/28/solidity-0.7.2-release-announcement/#notable-new-features).
23+
This option is available for contracts using Solidity 0.7.2 or greater. See the solidity blog for more details about [generated sources](https://soliditylang.org/blog/2020/09/28/solidity-0.7.2-release-announcement/#:~:text=Notable%20New%20Features).
2424

2525
Using **generated sources** will make it easier to audit your contracts. When the option is checked, you can step into those compiler outputs — while debugging.
2626

@@ -164,4 +164,4 @@ Breakpoints can be placed in the gutter of the Editor to pause the debugger.
164164

165165
The debugger's granular information gives users detailed information about what is happening in a transaction - so not only is the debugger good for debugging, it is also an excellent teaching tool.
166166

167-
To learn about using the debugger, go to [Debugging Transactions](tutorial_debug.html).
167+
To learn about using the debugger, go to {doc}`Debugging Transactions </tutorial_debug>`.

docs/file_explorer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ There are two ways you can save the files you create and use on Remix to your ha
2828

2929
#### Remixd
3030

31-
Remixd is an NPM package that allows you to share a specified folder on your computer with Remix IDE. Thus, your files are saved on IndexedDB and on the specified folder. Learn more about Remixd on our [Remixd guide](remixd.html).
31+
Remixd is an NPM package that allows you to share a specified folder on your computer with Remix IDE. Thus, your files are saved on IndexedDB and on the specified folder. Learn more about Remixd on our {doc}`Remixd guide </remixd>`.
3232

3333
#### Remix Desktop
3434

docs/git.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ Alternatively, you can add username and email to the Github section of the Git p
1616

1717
### Initializing Git in a Workspace
1818

19-
For information about initializing a workspace, see the section about initializing Git on the [Remix Workspaces](/workspaces/#initializing-a-workspace-with-git) page.
19+
For information about initializing a workspace, see the section about initializing Git on the {ref}`Remix Workspaces <workspaces:initializing a workspace with git>` page.
2020

2121
### Cloning an existing repository into Remix
2222

2323
You can clone an existing repository from GitHub into Remix using "**CLONE**" accordion item in the Git plugin. You can clone a repository by loading it from GitHub using the "**Load from GitHub**" button and selecting one from your list of public repositories.
2424

25-
Alternatively, you can clone a repository by providing its URL in the "**CLONE FROM URL**" text box. When you clone a repository, Remix initializes it as a separate Workspace. See [Remix Workspaces](/workspaces) to learn more about Workspaces.
25+
Alternatively, you can clone a repository by providing its URL in the "**CLONE FROM URL**" text box. When you clone a repository, Remix initializes it as a separate Workspace. See {doc}`Remix Workspaces <workspaces>` to learn more about Workspaces.
2626

2727
```{note}
28-
Remix stores your files in the browser and browser storage is limited. Cloning a repository that is too large will cause the Remix IDE. This is why you have to manually specify the depth and branches you want to clone. If you are using [Remixd](/remixd) you don't have to worry about cloning large repositories.
28+
Remix stores your files in the browser and browser storage is limited. Cloning a repository that is too large will cause the Remix IDE. This is why you have to manually specify the depth and branches you want to clone. If you are using {doc}`Remixd </remixd>` you don't have to worry about cloning large repositories.
2929
```
3030

3131
![Remix Git plugin clone section.](images/git/gh-clone.png)

docs/hardhat.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ _(Supported since Remix IDE v0.12.0 and Remixd v0.3.6)_
44

55
## Remixd and Hardhat
66

7-
**Note:** If you have not used `remixd` before, read more about it [here](./remixd.html)
7+
```{note}
8+
If you have not used `remixd` before, read more about it {doc}`in the Remixd documentation </remixd>`.
9+
```
810

911
If `remixd` is running locally on your device and shared folder is a **Hardhat project**, an additional websocket plugin will be listening on port `65522`. According to its documentation,
1012

@@ -30,7 +32,7 @@ To use Hardhat compilation with Remix IDE efficiently:
3032

3133
### How to use
3234

33-
If a hardhat project is shared through remixd and `localhost` workspace is loaded in Remix IDE, there will be an extra checkbox shown in `Solidity Compiler` plugin with the label `Enable Hardhat Compilation`.
35+
If a hardhat project is shared through Remixd and `localhost` workspace is loaded in Remix IDE, there will be an extra checkbox shown in `Solidity Compiler` plugin with the label `Enable Hardhat Compilation`.
3436

3537
![](images/a-hardhat-compilation.png)
3638

docs/import.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ import "./myLovelyLovelyLib.sol";
6363

6464
### Importing a file from your computer's filesystem
6565

66-
This method uses **remixd** - the remix daemon. Please go to the [remixd docs](remixd.html) for instructions about how to bridge the divide between the browser and your computer's filesystem.
66+
This method uses **remixd** - the remix daemon. Please go to the {doc}`remixd docs </remixd>` for instructions about how to bridge the divide between the browser and your computer's filesystem.
6767

6868
### More about the import keyword
6969

0 commit comments

Comments
 (0)