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.

Sign up for GitHub

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

Jump to bottom

fixes link to style guide + tweaks #61

Merged
merged 5 commits into from
Oct 30, 2024
Merged

fixes link to style guide + tweaks #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
73505b5
fixes link to style guide + tweaks
m4sterbunny Oct 25, 2024
4cb8ed7
fixes relative link
m4sterbunny Oct 25, 2024
9c8f806
tidy up for POC to prod
m4sterbunny Oct 25, 2024
d03628b
Merge branch 'main' into 60-fix-link
alexandratran Oct 30, 2024
6416794
Update docs/contribute/style-guide.md
alexandratran Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions README.md
View file
Open in desktop
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
16 changes: 8 additions & 8 deletions docs/contribute/style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@
Style guidelines help keep the Consensys documentation consistent, concise, and readable.
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.
- [**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://docs.google.com/document/d/1smRdw4TUIpz9re_o0_0DKdH_nK6cSPMJOK6BcbhjJ7Y/edit?usp=sharing) -
- [**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.
This guide is only available to internal Consensys contributors.

The following section also highlights the top five style tips from these guides.
Expand Down Expand Up @@ -54,7 +54,7 @@

:::info example

❌ *If we are unable to find another library that works with the execution environment, another way
❌ *If we're unable to find another library that works with the execution environment, another way
of solving the problem is by patching the dependency ourselves.
For this, `patch-package` can be leveraged.*

Expand All @@ -69,10 +69,10 @@

- You don't need to market the product to the reader.
Understand what they're seeking to learn or do, and optimize your content to help them achieve
that quickly.
that fast.
- List prerequisites and suggest good practices.
For example, instruct readers to secure private keys and protect RPC endpoints in production environments.
- Write [code samples](format-markdown.md#code-sample-style-guide) that are readable, can be easily
- Write [code samples](format-markdown.md#code-sample-style-guide) that are readable, can be

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

View workflow job for this annotation

GitHub Actions / Lint

Trailing spaces 

docs/contribute/style-guide.md:75:93 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1] https://github.com/DavidAnson/markdownlint/blob/v0.35.0/doc/md009.md
copied and pasted, and work as expected.

:::info example
Expand Down Expand Up @@ -152,7 +152,7 @@

❌ *[Click here](https://discord.gg/hyperledger) for Besu support.*

✅ *If you have questions about Besu for public networks, ask on the **besu** channel on
[Hyperledger Discord](https://discord.gg/hyperledger).*
✅ *If you have questions about Besu for public networks, ask on the **#besu** channel on

Check warning on line 155 in docs/contribute/style-guide.md

View workflow job for this annotation

GitHub Actions / Spelling 

[vale] reported by reviewdog 🐶
[Consensys.CaseSensitive-Substitution] Consider standard format, '"Besu"' instead of "besu" (may not apply for start of sentence).

Raw Output:
{"message": "[Consensys.CaseSensitive-Substitution] Consider standard format, '\"Besu\"' instead of \"besu\" (may not apply for start of sentence).", "location": {"path": "docs/contribute/style-guide.md", "range": {"start": {"line": 155, "column": 72}}}, "severity": "WARNING"}
[LFDT Discord](https://discord.gg/hyperledger).*

:::
Loading