Skip to content

Commit

Permalink
tidy up for POC to prod
Browse files Browse the repository at this point in the history
  • Loading branch information
m4sterbunny committed Oct 25, 2024
1 parent 4cb8ed7 commit 9c8f806
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 15 deletions.
14 changes: 0 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,3 @@ 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

The title should do it, so should:

- Metamask
- ConsenSys
2 changes: 1 addition & 1 deletion docs/contribute/style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Refer to the following guides when writing, editing, or reviewing doc content:
- [**Microsoft Writing Style Guide**](https://learn.microsoft.com/en-us/style-guide/welcome/): Refer to this guide for style, voice, grammar, and text formatting guidelines.
- [**Diátaxis framework**](https://diataxis.fr/): Refer to this guide for information about
function-based docs.
- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](/run-vale.md) assists writers to adhere to this style.
- [**Consensys Editorial Style Guide**](https://www.notion.so/consensys/Consensys-Editorial-Style-Guide-d5b9867e85df4ae38f8bed44f61a77d5): Refer to this guide for spelling and usage of blockchain-related terms. [Vale](run-vale.md) assists writers to adhere to this style.

Check failure on line 14 in docs/contribute/style-guide.md

View workflow job for this annotation

GitHub Actions / Lint

Line length

docs/contribute/style-guide.md:14:201 MD013/line-length Line length [Expected: 200; Actual: 271] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md013.md
> This guide is only available to internal Consensys contributors.
The following section also highlights the top five style tips from these guides.
Expand Down

0 comments on commit 9c8f806

Please sign in to comment.