From 37a085a70659186beced40573710f1a30b22a0f3 Mon Sep 17 00:00:00 2001 From: m4sterbunny Date: Tue, 10 Sep 2024 14:36:33 +0100 Subject: [PATCH] adds nitpicks for vale --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 27c0b3a..ddeda54 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -# 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/). ## Linting @@ -12,3 +14,9 @@ Vale is a work in progress (WIP) for linting: `.github/workflows/lint.yml` uses 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 +- ConsenSys