-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
3285d4b
commit 37a085a
Showing
1 changed file
with
13 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/). | ||
|
||
## 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 | ||
- ConsenSys |