feat: add GitHub Actions for Vale

utils/vale/styles/Vocab/Ronin/accept.txt → .github/styles/Vocab/Ronin/accept.txt

@@ -3,24 +3,31 @@ bridge
 bridge operator
 bridge operator node
 delegator
+EVM
 full node
 Governing Validator
 Katana
 mainnet
+NFT
 node
 node operator
 non-validator node
+OIDC
+OpenID Connect
 RON
 RON Staking
 Ronin
 Ronin Block Explorer
 Ronin Bridge
 Ronin CLI
 Ronin mainnet
+Ronin Name Service
 Ronin Wallet
+RNS
 Saigon testnet
 Standard Validator
 testnet
+UTC
 validator
 Validator Candidate
 Validator Dashboard

.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Editorial review
+on: [pull_request]
+
+jobs:
+  vale:
+    name: runner / vale
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: errata-ai/vale-action@reviewdog
+        with:
+          files: docs
+          fail_on_error: true
+    env:
+      # Required
+      GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

.vale.ini

@@ -1,5 +1,5 @@
 # Relative path to the style directory
-StylesPath = utils/vale/styles
+StylesPath = .github/styles
 
 # Name of the vocabulary directory
 Vocab = Ronin
@@ -19,7 +19,8 @@ WordTemplate = \b(?:%s)\b
 [formats]
 mdx = md
 
-[*]
+[*.{md,txt}]
+
 BasedOnStyles = Google
 
 Google.FirstPerson = NO

docs/CONTRIBUTING.md

@@ -130,7 +130,7 @@
 ### Next steps
 
 After you address feedback from maintainers, your PR will be merged and your contributions will be visible on [docs.roninchain.com](https://docs.roninchain.com).
-Congratulations, you're a full-blown contributor!
+Congratulations, you're a full-blown contributor.
 
 ### Naming conventions
 
@@ -153,7 +153,7 @@
 
 * Don't capitalize the first letter, reserve that for proper nouns (product
   names, for example).
-* Use the imperative, present tense: "change" not "changed" nor "changes".
+* Use the imperative, present tense: "change" not "changed" nor "changes."
 * Don't add a period (.) at the end.
 
 ## Run locally
@@ -405,7 +405,7 @@
 
 An explanation topic works well when:
 
-* It answers questions "What is this?", "Why should I use it?", "How does it
+* It answers questions "What is this?," "Why should I use it?," "How does it
   work?"
 * It gives context to a subject or topic that your readers might not have.
 * It provides essential facts, background, and diagrams to help your readers
@@ -424,8 +424,8 @@
 
 ###### About title metadata in explanation topics
 
-To write a title for an explanation topic, use "About + noun" or "About + noun phrase", where to describe
-the subject. For example: "About events", "About data quality."
+To write a title for an explanation topic, use "About + noun" or "About + noun phrase," where to describe
+the subject. For example: "About events," "About data quality."
 
 ###### About the "Overview" section in explanations
 
@@ -483,8 +483,8 @@
 ###### About title metadata in how-to guides
 
 To write a title for a how-to guide, start with a verb.
-For example, "Get started", "Integrate with Ronin VRF", "Authenticate users
-with OIDC and Sky Mavis Account". The outcome of the task should be clear
+For example, "Get started," "Integrate with Ronin VRF," "Authenticate users
+with OIDC and Sky Mavis Account." The outcome of the task should be clear
 to the user from the title alone.
 
 ###### About the "Overview" section in how-to guides
@@ -496,7 +496,7 @@
 
 Explain what knowledge the user needs to have, or what configuration they must
 complete, before starting the task. Use imperative sentences, for example, "Read
-the explanation topic" or "Download and install the app".
+the explanation topic" or "Download and install the app."
 
 ###### About the "task name" section
 
@@ -555,8 +555,8 @@
 
 To write a title for a reference topic, use nouns that clearly describe the
 contents of the topic. Make sure that the title is accessible to users who are
-just getting started. For example, "Slashing rules", "Network parameters", "User
-roles".
+just getting started. For example, "Slashing rules," "Network parameters," "User
+roles."
 
 ###### About the "Overview" section in reference topics
 
@@ -569,7 +569,7 @@
   are documenting. You might find it helpful to organize the contents using
   tables, lists, interactive object-schemas. For example, if you're writing a
   reference page for an API endpoint, you might define sections such as "General
-  requirements", "Request parameters", and "Responses". The format  might be
+  requirements," "Request parameters," and "Responses." The format  might be
   different for each section—"General requirements" might be a list, while
   "Request parameters" and "Responses" are tables.
 * Use the "don't repeat yourself" (DRY) method and re-use content if it's
@@ -682,7 +682,7 @@
 
 Quickstarts enable a user to quickly complete a discrete, focused task by illustrating a workflow with only essential steps, in about five minutes or 600 words. Quickstarts can be used for quickly getting set up with a new tool, or for quickly completing another task. For more complex tasks, use a tutorial.
 
-Quickstarts are useful when someone already understands the feature or product and is ready to try it out. Users of quickstarts are not looking for an explanation and don't need to be convinced to use the product––they just want instructions quickly. Users who don't understand a step are willing to dig deeper in a separate doc.
+Quickstarts are useful when someone already understands the feature or product and is ready to try it out. Users of quickstarts are not looking for an explanation and don't need to be convinced to use the product-they just want instructions quickly. Users who don't understand a step are willing to dig deeper in a separate doc.
 
 ##### Quickstart template
 
@@ -692,7 +692,7 @@
 
 ###### About title metadata in quickstarts
 
-* When the guide helps someone get started with a new tool, preface the title with "Quickstart". For example, "Quickstart for Sky Mavis Account."
+* When the guide helps someone get started with a new tool, preface the title with "Quickstart." For example, "Quickstart for Sky Mavis Account."
 * For other use cases, follow the title guidelines for procedures and omit the word "Quickstart."
 
 ###### About the "Overview" section in quickstarts

docs/basics/introduction.md

@@ -6,7 +6,7 @@ description: What is Ronin?
 
 ## What is Ronin?
 
-Ronin is an EVM blockchain specifically forged for gaming. Launched by Sky Mavis, the creator of Web3’s breakout title Axie Infinity which has generated over $1.3B in revenue, Ronin is the only blockchain proven to scale a single game to accommodate millions of daily active users and has processed over $4B in NFT volumes. Ronin optimizes for near-instant transactions and negligible fees that enable millions of in-game transactions to occur seamlessly, making it the leading choice for Web3 games.
+Ronin is an EVM blockchain specifically forged for gaming. Launched by Sky Mavis, the creator of Web3’s breakout title Axie Infinity which has generated over $1.3 B in revenue, Ronin is the only blockchain proven to scale a single game to accommodate millions of daily active users and has processed over $4 B in NFT volumes. Ronin optimizes for near-instant transactions and negligible fees that enable millions of in-game transactions to occur seamlessly, making it the leading choice for Web3 games.
 
 ## What makes Ronin unique as a blockchain?
 

docs/basics/key-concepts.md

@@ -37,7 +37,7 @@
 
 ### BLS key
 
-Boneh–Lynn–Shacham (BLS) is a digital signature method used for verifying the authenticity of digital messages or documents. 
+Boneh-Lynn-Shacham (BLS) is a digital signature method used for verifying the authenticity of digital messages or documents. 
 
 The BLS key is what the validator uses to produce finality votes. Validators who produce finality vote receive a reward. If a validator fails to produce a finality vote, no slashing penalty applies.
 

docs/validators/manage/take-emergency-exit.mdx

@@ -25,7 +25,7 @@
 
 Based on the Governing Validators' vote on your Emergency Exit proposal, your stake may be refunded as follows:
 
-- If the proposal is approved, your entire self-stake is refunded: 50,000 RON is credited immediately, while the remaining amount is transferred to you the next day (00:00 UTC).
-- If the proposal is not approved or expires, you're refunded the amount equal to your self-stake minus 50,000 RON. The amount is transferred to you after seven working days from the proposal's creation date.
+* If the proposal's approved, your entire self-stake is refunded: 50,000 RON is credited immediately, while the remaining amount is transferred to you the next day (00:00 UTC).
+* If the proposal's not approved or expires, you're refunded the amount equal to your self-stake minus 50,000 RON. The amount is transferred to you after seven working days from the proposal's creation date.
 
-After your emergency exit is complete, you can no longer validate transactions on Ronin and receive rewards. Your status is set to "Renounced".
+After your emergency exit is complete, you can no longer validate transactions on Ronin and receive rewards. Your status is set to "Renounced."

docs/validators/setup/generate-keys.md

@@ -10,10 +10,10 @@
 
 Each validator node requires private keys for signing blocks and consensus messages sent to the other validators in the network.
 
-The required private keys include a BLS key and an ECDSA key. The keys are named after digital signature schemes: Elliptic Curve Digital Signature Algorithm (ECDSA) and Boneh–Lynn–Shacham (BLS), respectively.
+The required private keys include a BLS key and an ECDSA key. The keys are named after digital signature schemes, Elliptic Curve Digital Signature Algorithm (ECDSA) and Boneh-Lynn-Shacham (BLS), respectively.
 
-- The BLS key is used for producing finality votes. Validators who produce finality votes receive a reward.
-- The ECDSA key is used for signing blocks.
+* The BLS key is used for producing finality votes. Validators who produce finality votes receive a reward.
+* The ECDSA key is used for signing blocks.
 
 ## Generate a BLS key
 
@@ -22,37 +22,38 @@
 ### Generate using the CLI
 
 1. Build Ronin from the source code:
-   ```
+
+   ```bash
    $ git clone https://github.com/axieinfinity/ronin
    $ cd ronin
    $ make ronin
    ```
 
 2. Add `./build/bin/ronin` to the `$PATH` environment variable. You can do this by adding the following line to your `$HOME/.profile` or `/etc/profile` (for a system-wide installation):
 
-   ```
+   ```bash
    export PATH=$PATH:/path/to/ronin
    ```
 
    If run from the `ronin` directory, then the command is as follows:
-    
-   ```
+
+   ```bash
    export PATH=$PATH:./build/bin/ronin
    ```
 
    **Note:** Make sure to close and reopen the terminal after adding the path.
 
 3. Generate a BLS key pair:
 
-   ```
+   ```bash
    $ mkdir bls_keystore
    $ echo "input_your_password" > bls_password
    $ ronin account generatebls --secret
    ```
 
    The output is the following:
 
-   ```
+   ```bash
    Successfully generated BLS key
    Public key: {your_public_key}
    Secret key: {your_private_key}
@@ -62,25 +63,25 @@
 
    To reveal the public key, run this command:
 
-   ```
-   $ ronin account listbls
+   ```bash
+   ronin account listbls
    ```
 
    The output is the following:
 
-   ```
+   ```bash
    BLS public key #0: {your_public_key}
    ```
 
    To reveal both the public key and private key, run this command:
 
+   ```bash
+   ronin account listbls --secret
    ```
-   $ ronin account listbls --secret
-   ```
-
+
    The output is the following:
 
-   ```
+   ```bash
    BLS public key #0: {your_public_key}
    BLS secret key #0: {your_private_key}
    ```
@@ -101,9 +102,9 @@
 
 ## Generate an ECDSA key
 
-You can generate an ECDSA key pair using the Ronin CLI or the Ronin Wallet app or extension.
+You can generate an ECDSA key pair using the Ronin command-line tool (CLI) or the Ronin Wallet app or extension.
 
-### Generate using the CLI
+### Generate an ECDSA key using the CLI
 
 #### Prerequisites
 
@@ -114,8 +115,8 @@
 #### Steps
 
 1. Compile the `ethkey` tool from the Ronin source code by running the following commands:
-   
-   ```
+
+   ```bash
    $ git clone https://github.com/axieinfinity/ronin
    $ cd ronin
    $ go get ./...
@@ -125,20 +126,20 @@
 
    The output is similar to the following:
 
-   ```
+   ```bash
    -rwxr-xr-x 1 user staff 16306850 Mar 23 18:13 ethkey
    ```
 
 2. Generate the key pair and set a password:
 
-   ```
-   $ ./ethkey generate your_private_key_name
+   ```bash
+   ./ethkey generate your_private_key_name
    ```
 
 3. Reveal the key pair:
 
-   ```
-   $ ./ethkey inspect --private your_private_key_name
+   ```bash
+   ./ethkey inspect --private your_private_key_name
    ```
 
 ### Generate using Ronin Wallet
@@ -147,13 +148,13 @@
 
 #### Browser extension
 
-<img src={extension} width={1440} />
+<img src={extension} width={1200} />
 
 #### Mobile app
 
-<img src={mobile} width={1440} />
+<img src={mobile} width={1200} />
 
 ## See also
 
-- [REP-0003: Optimistic Fast Finality](https://github.com/axieinfinity/REPs/blob/main/REP-0003.md#rewards)
-- [Build a Ronin CLI](./cli.md)
+* [REP-0003: Optimistic Fast Finality](https://github.com/axieinfinity/REPs/blob/main/REP-0003.md#rewards)
+* [Build a Ronin CLI](./cli.md)