Merge pull request #3249 from davidekete/fix-linting-issues

Fix linting issues

Author: ryestew

docs/FAQ.md

@@ -1,6 +1,6 @@
 # FAQ
 
-### Supported devices & Browsers
+## Supported devices & Browsers
 
 **Q:** What browsers will Remix work on?
 
@@ -10,7 +10,7 @@
 
 **A:** We do not support the use of Remix on tablets or mobile phones.
 
-### General
+## General
 
 **Q:** Are there keyboard shortcuts in Remix?
 
@@ -26,7 +26,7 @@
 
 `Ctrl+Shift+A` : Opens the Plugin Manager
 
-### Solidity compiler
+## Solidity Compiler
 
 **Q:** Error: compiler might be in a non-sane state
 
@@ -36,20 +36,20 @@ The compiler might be in a non-sane state, please be careful and do not use furt
 It is heavily recommended to use another browser not affected by this issue (Firefox is known to not be affected)."
 ```
 
-**A:** Old versions of solidity compiler had this problem with chrome.
+**A:** Old versions of Solidity Compiler had this problem with chrome.
 Please change the compiler version in Solidity Plugin to the newer one or use another browser.
 
 **Q:** I’m getting an issue with Maximum call stack exceed and various other errors, can't compile.
 
-**A:** Try a different browser or a newer solidity compiler version.
+**A:** Try a different browser or a newer Solidity Compiler version.
 
 **Q:** How to verify a contract that imports other contracts?
 
 **A:** The verification tool does not recursively go through the import statements in a contract. So can only verify a 'flattened' contract.
 
 A contract can be 'flattened' by right-clicking on it in the File Explorer and choosing the `Flatten` option. This will assemble all the original code as well as the imported code into a single file.
 
-### Deploy & Run
+## Deploy & Run
 
 **Q:** I am using an Infura endpoint in my app, but when I try to deploy against that endpoint in Remix IDE selecting "External HTTP Provider" and putting my endpoint in, it's telling me that it can't connect
 
@@ -104,13 +104,13 @@ contract daPeeps {
 The input of initPeepToPeeps takes a struct. If you input
 `[1,2]` the transaction will go through.
 
-### Plugin Developers
+## Plugin Developers
 
 **Q:** Where do plugin developers go with their questions?
 
 **A:** First, join our [Discord server](https://discord.com/invite/zUNteAzJs3) and then go to the development-plugin channel.
 
-### Analytics
+## Analytics
 
 **Q:** What information does Remix save when Matomo Analytics is enabled?
 

docs/account-abstraction-7702.md

@@ -97,6 +97,6 @@ When the transaction goes through, go to Remix’s terminal and click the new tr
 
 ![Remix terminal showing the smart contract account and its associated bundler.](images/account-abstraction-7702/a-aa-gsa-log.png)
 
-You will see both the Smart Contract Account and its associated Bundler.
+You will see both the Smart Contract Account and its associated bundler.
 
 Note: Following [EIP-155](https://eips.ethereum.org/EIPS/eip-155), Safe Smart Account contracts use a deterministic deployment proxy so for a contract deployed using a smart account, the msg.sender will be: 0x4e59b44847b379578588920cA78FbF26c0B4956C.

docs/ai.md

@@ -1,6 +1,6 @@
 # AI Tools
 
-Remix has its own AI tool named **RemixAI** and a sub-project called **RemixAI Copilot** for code completion. 
+Remix has its own AI tool named **RemixAI** and a sub-project called **RemixAI Copilot** for code completion.
 
 When you load Remix, the **RemixAI Assistant** appears in the Right Side Panel.
 
@@ -24,9 +24,11 @@ In the RemixAI Assistant, there is a choice of LLMs for use in **code explanatio
 ![RemixAI LLM dropdown menu.](images/ai/llm-dropdown.png)
 
 ## Natural languages and RemixAI
+
 The RemixAI Assistant will respond to a question in the language in which it's asked.
 
 ## Computer languages and RemixAI
+
 RemixAI will be able to answer questions about Solidity, JS/TS, Vyper and other computer languages.
 
 ## Adding context to the LLM
@@ -41,7 +43,7 @@ You can also set the context to the current Workspace while you type, by startin
 
 When you type a space or a new line, the RemixAI Assistant will propose some code. The proposed code is a technique called, **code completion**. The RemixAI Assistant's suggested code will take into account what has already been written in the file.
 
-The switch to activate it is at the bottom left of the Main Panel when a file is active. Once activated, suggests code using MistralAI LLM.  For **code completion** there is no choice of LLM.
+The switch to activate it is at the bottom left of the Main Panel when a file is active. Once activated, suggests code using MistralAI LLM. For **code completion** there is no choice of LLM.
 
 ![Remix AI Copilot button.](images/ai/a-ai-switch.png)
 

docs/compile.md

@@ -116,4 +116,4 @@ There is no error checking when using the .json file for configuration settings,
 
 ### Use a Custom Solidity Compiler
 
-For those writing your own custom solidity compiler, you can import that by clicking the **+** button (**X. in fig 1**) to open a modal where you can input the url of the compiler to be loaded.
+For those writing your own custom Solidity Compiler, you can import that by clicking the **+** button (**X. in fig 1**) to open a modal where you can input the url of the compiler to be loaded.

docs/create_deploy.md

@@ -59,7 +59,6 @@ A quick way to compile is to hit **ctrl + s**. You can also compile by going to
 
 Go to the **Deploy & Run Transactions** plugin.
 
-
 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.
 
 For a brief synopsis:

docs/foundry.md

@@ -22,7 +22,7 @@ Now, one can start deploying the contract from Remix IDE to the local Anvil node
 
 Foundry manages dependencies using git submodules and can remap dependencies to make them easier to import. So import defined by remappings can have compilation errors on Remix IDE.
 
-To support such compilation, Remix suggests running [compilation using a compiler config file](https://remix-ide.readthedocs.io/en/latest/compile.html#json-file-for-compiler-configuration). Remix adds some default Forge remappings in the compiler config file when a Foundry project is loaded in Remix IDE using remixd.
+To support such compilation, Remix suggests running [compilation using a compiler config file](https://remix-ide.readthedocs.io/en/latest/compile.html#json-file-for-compiler-configuration). Remix adds some default Forge remappings in the compiler config file when a Foundry project is loaded in Remix IDE using Remixd.
 
 ![](images/a-foundry-cc.png)
 

docs/git.md

@@ -63,7 +63,7 @@ You can view the output of some of these commands on the "**LOGS**" accordion it
 
 You can manage the multiple branches associated with your Workspace initialized with Git or cloned from GitHub from the "**BRANCHES**" accordion item.
 
-![Remix Git Plugin showing multiple branches](images/git/gh-git-branches.png)
+![Remix Git plugin showing multiple branches](images/git/gh-git-branches.png)
 
 You can view the current branch from the Footer.
 

docs/hardhat.md

@@ -8,13 +8,13 @@ _(Supported since Remix IDE v0.12.0 and Remixd v0.3.6)_
 If you have not used `remixd` before, read more about it {doc}`in the Remixd documentation </remixd>`.
 ```
 
-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,
+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,
 
 > _Hardhat projects are npm projects with the hardhat package installed and a hardhat.config.js or hardhat.config.ts file._
 
-Remixd looks for the `hardhat.config.js` or `hardhat.config.ts` file in shared folder, and if it finds the file, the Hardhat websocket listener will run.
+Remixd looks for the `hardhat.config.js` or `hardhat.config.ts` file in shared folder, and if it finds the file, the Hardhat WebSocket listener will run.
 
-The Hardhat websocket listener is a websocket plugin similar to `remixd` and is used to perform Hardhat specific actions with Remix IDE.
+The Hardhat WebSocket listener is a WebSocket plugin similar to `remixd` and is used to perform Hardhat specific actions with Remix IDE.
 
 It doesn't need any separate installation as it is shipped with [remixd NPM](https://www.npmjs.com/package/@remix-project/remixd) module.
 
@@ -28,7 +28,7 @@ To use Hardhat compilation with Remix IDE efficiently:
 
 1. **Hardhat** should be installed locally on the system [https://hardhat.org/getting-started/#installation](https://hardhat.org/getting-started/#installation)
 2. Shared folder should be a Hardhat project containing `hardhat.config.js` or `hardhat.config.ts`
-3. `Remixd` Hardhat websocket listener should be running at `65522`
+3. `Remixd` Hardhat WebSocket listener should be running at `65522`
 
 ### How to use
 
@@ -46,7 +46,7 @@ The result of the compilation will be shown in the Remix IDE terminal
 
 ![](images/a-hardhat-compilation-success.png)
 
-and also in the **remixd** terminal.
+and also in the **Remixd** terminal.
 
 ![](images/a-hardhat-compilation-success-remixd.png)
 

docs/import.md

@@ -63,7 +63,7 @@ import "./myLovelyLovelyLib.sol";
 
 ### Importing a file from your computer's filesystem
 
-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.
+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.
 
 ### More about the import keyword
 

docs/locations.md

@@ -58,13 +58,13 @@ https://remix.ethereum.org/?#deactivate=debugger
 
 ### Minimizing Remix panels
 
-The following URL will **close everything except the main panel & the icon panel** (the side and terminal are minimized).
+The following URL will **close everything except the Main Panel & the icon panel** (the side and terminal are minimized).
 
 ```text
 https://remix.ethereum.org/?#embed=true
 ```
 
-To minimize just the side panel, use this URL:
+To minimize just the Side Panel, use this URL:
 
 ```text
 https://remix.ethereum.org/?#minimizesidepanel=true
@@ -88,7 +88,7 @@ To link to Remix with a theme specified use this url:
 
 To link to Remix with the list of plugins activated and with:
 
-- the Learneth gaining the side panel's focus (because it is the last in the list)
+- the LearnEth gaining the Side Panel's focus (because it is the last in the list)
 - the Light theme loaded
 - the terminal minimized
 - optimize off
@@ -193,15 +193,15 @@ https://remix.ethereum.org/?#activate=solidity,fileManager&gist=0fe90e825327ef31
 https://remix.ethereum.org/?#activate=solidity,LearnEth&gist=0fe90e825327ef313c88aedfe66ec142&call=fileManager//open//gist-0fe90e825327ef313c88aedfe66ec142/gridMix4.sol
 ```
 
-## Load a specific version of the Solidity compiler:
+## Load a specific version of the Solidity Compiler:
 
 ```text
 https://remix.ethereum.org/?#version=soljson-v0.6.6+commit.6c089d02
 ```
 
 **Note:** you need to specify both the Solidity version and the commit.
 
-## Load a custom Solidity compiler:
+## Load a custom Solidity Compiler:
 
 ```text
 https://remix.ethereum.org/#version=https://solidity-blog.s3.eu-central-1.amazonaws.com/data/08preview/soljson.js
@@ -215,7 +215,7 @@ https://remix.ethereum.org/#autoCompile=true
 
 ## Select the language for the Solidity Compiler
 
-Choose YUL or Solidity with the language parameter.
+Choose Yul or Solidity with the language parameter.
 
 ```text
 https://remix.ethereum.org/#language=Yul