Skip to content

Commit

Permalink
adds testing to within docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@m4sterbunny
m4sterbunny committed Sep 26, 2024
1 parent 96bdfb1 commit 3e3dab0
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@ Welcome to the Consensys documentation guide.
This guide contains information about contributing to Consensys developer documentation sites and
creating new documentation sites.

### Let us Upset Vale

Check warning on line 11 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Consensys.Headings] 'Let us Upset Vale' should use sentence-style capitalization.

Raw Output:
{"message": "[Consensys.Headings] 'Let us Upset Vale' should use sentence-style capitalization.", "location": {"path": "docs/index.md", "range": {"start": {"line": 11, "column": 5}}}, "severity": "WARNING"}

Should trigger
With off brand Metamask

Check failure on line 14 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Vale.Terms] Use 'MetaMask' instead of 'Metamask'.

Raw Output:
{"message": "[Vale.Terms] Use 'MetaMask' instead of 'Metamask'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 14, "column": 16}}}, "severity": "ERROR"}
′
″
zk-EVM

Check failure on line 17 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Vale.Avoid] Avoid using 'zk-EVM'.

Raw Output:
{"message": "[Vale.Avoid] Avoid using 'zk-EVM'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 17, "column": 3}}}, "severity": "ERROR"}

Shouldn't trigger
goerli

Check failure on line 20 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'goerli'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'goerli'?", "location": {"path": "docs/index.md", "range": {"start": {"line": 20, "column": 1}}}, "severity": "ERROR"}

Check failure on line 20 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Vale.Avoid] Avoid using 'goerli'.

Raw Output:
{"message": "[Vale.Avoid] Avoid using 'goerli'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 20, "column": 1}}}, "severity": "ERROR"}
Goerli

Check failure on line 21 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'Goerli'?

Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'Goerli'?", "location": {"path": "docs/index.md", "range": {"start": {"line": 21, "column": 1}}}, "severity": "ERROR"}

Check failure on line 21 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Vale.Avoid] Avoid using 'Goerli'.

Raw Output:
{"message": "[Vale.Avoid] Avoid using 'Goerli'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 21, "column": 1}}}, "severity": "ERROR"}
booleans
celo
whitelist

Check failure on line 24 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Vale.Avoid] Avoid using 'whitelist'.

Raw Output:
{"message": "[Vale.Avoid] Avoid using 'whitelist'.", "location": {"path": "docs/index.md", "range": {"start": {"line": 24, "column": 1}}}, "severity": "ERROR"}

Check failure on line 24 in docs/index.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Consensys.Inclusive] Consider using "allowlist", "trustlist", or "safelist" instead of "whitelist"

Raw Output:
{"message": "[Consensys.Inclusive] Consider using \"allowlist\", \"trustlist\", or \"safelist\" instead of \"whitelist\"", "location": {"path": "docs/index.md", "range": {"start": {"line": 24, "column": 1}}}, "severity": "ERROR"}


## Overview

Each Consensys developer product has a documentation site, maintained by the [Consensys developer
Expand Down

0 comments on commit 3e3dab0

Please sign in to comment.