Skip to content

Commit

Permalink
adds nitpicks for vale
Browse files Browse the repository at this point in the history
  • Loading branch information
m4sterbunny committed Sep 10, 2024
1 parent 3285d4b commit 37a085a
Showing 1 changed file with 13 additions and 5 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
# ConsenSys Documentation Template and Guide
# Consensys docs template and guide

This repository is a template for creating new ConsenSys documentation sites. It's built using
[Docusaurus](https://docusaurus.io/).
This repository is a template for creating new Consensys documentation sites.
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/).

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/).

Check failure on line 10 in README.md

View workflow job for this annotation

GitHub Actions / Lint Code Base, Spelling, Link Check

Multiple consecutive blank lines: Expected: 1; Actual: 2
## 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

The title should do it, so should:
- Metamask

Check failure on line 21 in README.md

View workflow job for this annotation

GitHub Actions / Lint Code Base, Spelling, Link Check

Lists should be surrounded by blank lines [Context: - Metamask]
- ConsenSys

0 comments on commit 37a085a

Please sign in to comment.