Skip to content

Commit

Permalink
Merge branch 'main' into 60-fix-link
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexandratran
alexandratran authored Oct 30, 2024
2 parents 9c8f806 + 0a0fb43 commit d03628b
Show file tree
Hide file tree
Showing 4 changed files with 116 additions and 132 deletions.
17 changes: 9 additions & 8 deletions docs/contribute/run-vale.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ view issues in real-time.

1. [Install Vale locally](https://vale.sh/docs/vale-cli/installation/#package-managers).

1. Checkout the repo containing our Vale settings:
1. Clone the repo containing our Vale settings:

```bash
git clone https://github.com/Consensys/docs-gha.git
Expand All @@ -44,10 +44,11 @@ view issues in real-time.
export VALE_CONFIG_PATH="/Users/{user-name}/documentation/docs-gha/spelling/.vale.ini"
```

:::note
To persist the ENV variable across sessions you’ll need to add the above command it to the appropriate
file. For example `~/.zshrc` (default shell in newer macOS versions).
:::
:::note
To persist the `VALE_CONFIG_PATH` environment variable across sessions, you’ll need to add the above command to the
appropriate shell configuration file. For example, on macOS, add it to ~/.zshrc (the default shell configuration
file in recent versions of macOS).
:::

1. Run the `vale` command in your terminal with the location of your file. For example:

Expand All @@ -64,11 +65,11 @@ view issues in real-time.
### Use the VS Code integration
You must have the VS Code editor installed to use this integration.
You must have the [Visual Studio (VS) Code](https://code.visualstudio.com) editor installed to use this integration.
1. [Install Vale locally](https://vale.sh/docs/vale-cli/installation/#package-managers).
1. Checkout the repo containing our Vale settings:
1. Clone the repo containing our Vale settings:
```bash
git clone https://github.com/Consensys/docs-gha.git
Expand All @@ -78,7 +79,7 @@ You must have the VS Code editor installed to use this integration.
1. In the settings for the Vale VS Code extension, set the location of the `.vale.ini` file, and
enable the spell check. The `.vale.ini` file is located within the `spelling` directory in the
`docs-gha` repo that you checked out.
`docs-gha` repo that you cloned onto your local.
![VS Code extension settings](../assets/vs-code-ext.png)
Expand Down
10 changes: 6 additions & 4 deletions docs/contribute/style-guide.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ sidebar_position: 2
Style guidelines help keep the Consensys documentation consistent, concise, and readable.
Refer to the following guides when writing, editing, or reviewing doc content:

- [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/): Refer to this guide for style, voice, grammar, and text formatting guidelines.
- [**Diátaxis framework**](https://diataxis.fr/): Refer to this guide for information about
- [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/) - Refer to this guide for style, voice, grammar, and text formatting guidelines.
- [**Diátaxis framework**](https://diataxis.fr/) - Refer to this guide for information about
function-based docs.
- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](run-vale.md) assists writers to adhere to this style.
> This guide is only available to internal Consensys contributors.
- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5) -
Refer to this guide for spelling and usage of blockchain-related terms.
[Vale](run-vale.md) assists writers to adhere to this style.
This guide is only available to internal Consensys contributors.

The following section also highlights the top five style tips from these guides.

Expand Down
36 changes: 18 additions & 18 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,22 +32,22 @@ and hosted on [Vercel](https://vercel.com/).
The following table shows the full list of developer documentation sites supported by Consensys.

<!-- markdownlint-disable -->
| Doc site | GitHub repository | Site platform | Hosting platform | Description |
|---------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|---------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Teku](https://docs.teku.consensys.net/) | [`consensys/doc.teku`](https://github.com/consensys/doc.teku) | Docusaurus | Vercel | Maintained by the docs team. |
| [Hyperledger Besu](https://besu.hyperledger.org/) | [`hyperledger/besu-docs`](https://github.com/hyperledger/besu-docs) | Docusaurus | GitHub Pages | Maintained by the docs team. This is a Hyperledger project and has its own [Besu docs contribution guidelines](https://wiki.hyperledger.org/display/BESU/Documentation). |
| [Web3Signer](https://docs.web3signer.consensys.net/) | [`consensys/doc.web3signer`](https://github.com/consensys/doc.web3signer) | Docusaurus | Vercel | Maintained by the docs team. |
| [MetaMask](https://docs.metamask.io/) | [`metamask/metamask-docs`](https://github.com/MetaMask/metamask-docs) | Docusaurus | Vercel | Maintained by the docs team. This project has additional [MetaMask docs contribution guidelines](https://github.com/MetaMask/metamask-docs/blob/main/CONTRIBUTING.md). |
| MetaMask Delegation Toolkit (private) | `metamask/gator-docs` (private) | Docusaurus | Vercel | Maintained by the docs team. |
| [Infura](https://docs.infura.io/infura/) | `infura/docs` (private) | Docusaurus | Vercel | Maintained by the docs team. |
| [Linea](https://docs.linea.build/) | [`consensys/doc.linea`](https://github.com/Consensys/doc.linea) | Docusaurus | Vercel | Maintained by the docs team. |
| [MetaFi](https://fantastic-goggles-eyo7zmp.pages.github.io/) | `consensys-vertical-apps/cx-api-docs` (private) | Docusaurus | GitHub Pages | Maintained by the docs team and the MetaFi team. |
| [Phosphor](https://docs.phosphor.xyz/) | `consensys/doc.consensys-nft` (private) | Docusaurus | Vercel | Maintained by the Phosphor team. |
| [MetaMask Fiat On-Ramp](https://docs.metamask-onramp.consensys.net/) | `consensys/doc.metamask-onramp` (private) | Docusaurus | Vercel | Maintained by the MetaMask Fiat On-Ramp team. |
| [GoQuorum](https://docs.goquorum.consensys.net/) | [`consensys/doc.goquorum`](https://github.com/consensys/doc.goquorum) | Docusaurus | Vercel | Maintained by the docs team. |
| [Tessera](https://docs.tessera.consensys.net/) | [`consensys/doc.tessera`](https://github.com/consensys/doc.tessera) | Docusaurus | Vercel | Maintained by the docs team. |
| [EthSigner](https://docs.ethsigner.consensys.net/) | [`consensys/doc.ethsigner`](https://github.com/consensys/doc.ethsigner) | Docusaurus | Vercel | Maintained by the docs team. |
| [gnark](https://docs.gnark.consensys.net/) | [`consensys/doc.gnark`](https://github.com/consensys/doc.gnark) | Docusaurus | Vercel | Maintained by the docs team. |
| [MetaMask Institutional](https://consensys-vertical-apps.github.io/metamask-institutional.docs/) | `consensys-vertical-apps/metamask-institutional.docs` (private) | Docusaurus | GitHub Pages | Maintained by the MetaMask Institutional team. |
| [Documentation guide](https://docs-template.consensys.net/) (this site) | [`consensys/docs-template`](https://github.com/consensys/docs-template) | Docusaurus | Vercel | Maintained by the docs team. |
| Doc site | GitHub repository | Site platform | Hosting platform | Description |
|--------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------|---------------|------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [Teku](https://docs.teku.consensys.net/) | [`consensys/doc.teku`](https://github.com/consensys/doc.teku) | Docusaurus | Vercel | Maintained by the docs team. |
| [Hyperledger Besu](https://besu.hyperledger.org/) | [`hyperledger/besu-docs`](https://github.com/hyperledger/besu-docs) | Docusaurus | GitHub Pages | Maintained by the docs team. This is a Hyperledger project and has its own [Besu docs contribution guidelines](https://wiki.hyperledger.org/display/BESU/Documentation). |
| [Web3Signer](https://docs.web3signer.consensys.net/) | [`consensys/doc.web3signer`](https://github.com/consensys/doc.web3signer) | Docusaurus | Vercel | Maintained by the docs team. |
| [MetaMask](https://docs.metamask.io/) | [`metamask/metamask-docs`](https://github.com/MetaMask/metamask-docs) | Docusaurus | Vercel | Maintained by the docs team. This project has additional [MetaMask docs contribution guidelines](https://github.com/MetaMask/metamask-docs/blob/main/CONTRIBUTING.md). |
| [MetaMask Delegation Toolkit](https://docs.gator.metamask.io/) | `metamask/gator-docs` (private) | Docusaurus | Vercel | Maintained by the docs team. |
| [Infura](https://docs.infura.io/infura/) | `infura/docs` (private) | Docusaurus | Vercel | Maintained by the docs team. |
| [Linea](https://docs.linea.build/) | [`consensys/doc.linea`](https://github.com/Consensys/doc.linea) | Docusaurus | Vercel | Maintained by the docs team. |
| [MetaFi](https://fantastic-goggles-eyo7zmp.pages.github.io/) | `consensys-vertical-apps/cx-api-docs` (private) | Docusaurus | GitHub Pages | Maintained by the docs team and the MetaFi team. |
| [Phosphor](https://docs.phosphor.xyz/) | `consensys/doc.consensys-nft` (private) | Docusaurus | Vercel | Maintained by the Phosphor team. |
| [MetaMask Fiat On-Ramp](https://docs.metamask-onramp.consensys.net/) | `consensys/doc.metamask-onramp` (private) | Docusaurus | Vercel | Maintained by the MetaMask Fiat On-Ramp team. |
| [GoQuorum](https://docs.goquorum.consensys.net/) | [`consensys/doc.goquorum`](https://github.com/consensys/doc.goquorum) | Docusaurus | Vercel | Maintained by the docs team. |
| [Tessera](https://docs.tessera.consensys.net/) | [`consensys/doc.tessera`](https://github.com/consensys/doc.tessera) | Docusaurus | Vercel | Maintained by the docs team. |
| [EthSigner](https://docs.ethsigner.consensys.net/) | [`consensys/doc.ethsigner`](https://github.com/consensys/doc.ethsigner) | Docusaurus | Vercel | Maintained by the docs team. |
| [gnark](https://docs.gnark.consensys.net/) | [`consensys/doc.gnark`](https://github.com/consensys/doc.gnark) | Docusaurus | Vercel | Maintained by the docs team. |
| [MetaMask Institutional](https://consensys-vertical-apps.github.io/metamask-institutional.docs/) | `consensys-vertical-apps/metamask-institutional.docs` (private) | Docusaurus | GitHub Pages | Maintained by the MetaMask Institutional team. |
| [Documentation guide](https://docs-template.consensys.net/) (this site) | [`consensys/docs-template`](https://github.com/consensys/docs-template) | Docusaurus | Vercel | Maintained by the docs team. |
<!-- markdownlint-restore -->
Loading

0 comments on commit d03628b

Please sign in to comment.