Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Vale #51

Closed
wants to merge 19 commits into from
Closed

Vale #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
4b3f06b
title case to trigger vale
m4sterbunny Sep 10, 2024
59143fd
test things on the vale branch of the workflows
joshuafernandes Sep 11, 2024
7c1fac8
test things on the vale branch of the workflows
joshuafernandes Sep 11, 2024
cdbdb8f
edit to heading to trigger vale on PR
m4sterbunny Sep 11, 2024
7afee8e
merge with main
m4sterbunny Sep 25, 2024
0e16248
Vale play
m4sterbunny Sep 25, 2024
c740eab
pulling files from main in case of merge conflict bad fix
m4sterbunny Sep 25, 2024
eb7d61d
spurious edit to retrigger vale check
m4sterbunny Sep 25, 2024
1dba992
spurious edit to retrigger vale check
m4sterbunny Sep 25, 2024
ecae431
removes deliberate error from index
m4sterbunny Sep 25, 2024
c2b1231
spurious edit to retrigger vale check
m4sterbunny Sep 25, 2024
bdf66eb
adds project words
m4sterbunny Sep 25, 2024
525c164
forces diff
m4sterbunny Sep 25, 2024
2fbd00a
forces diff
m4sterbunny Sep 25, 2024
4282b49
spurious edit to retrigger vale check
m4sterbunny Sep 25, 2024
357b9a7
spurious edit to retrigger vale check
m4sterbunny Sep 25, 2024
f6b2d6d
spurious edit to retrigger vale check
m4sterbunny Sep 25, 2024
96bdfb1
attempting to duplicate vale output on gha
m4sterbunny Sep 25, 2024
3e3dab0
adds testing to within docs
m4sterbunny Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,10 @@ Consensys/docs-gha/lint@main.

WIP: That GHA repo should be set up to apply the [Vale linting set](https://github.com/ConsenSys/docs-gha/tree/main/spelling).


### Let's Upset Vale

The title should do it, so should:
## Test This

- Metamask
- ConsenSys
title should trigger
ConsenSys should trigger
16 changes: 16 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@
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
Loading