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.

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 #44

Merged
merged 14 commits into from
Sep 10, 2024
1 change: 0 additions & 1 deletion .github/workflows/lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ jobs:
contents: read
steps:
- uses: actions/checkout@v4

- name: Lint
uses: ConsenSys/docs-gha/lint@main
with:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/spelling.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ on:
pull_request:
branches:
- main
- vale

jobs:
vale:
Expand All @@ -16,7 +17,7 @@ jobs:
- uses: actions/checkout@v4

- name: Vale
uses: ConsenSys/docs-gha/spelling@main
uses: Consensys/docs-gha/spelling@main
with:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,17 @@ It's built using [Docusaurus](https://docusaurus.io/).
It also contains a written guide for contributing to Consensys docs, and creating, configuring, and
testing new doc sites, published at
[`docs-template.consensys.net`](https://docs-template.consensys.net/).

## Linting

Vale is a work in progress (WIP) for linting: `.github/workflows/lint.yml` uses actions set up on
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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure this will upset Vale
image
I think it may be constrained to look in the stated folders only and README aint in one!


The title should do it, so should:

- Metamask
- ConsenSys
Loading