Vale#14
Open
m4sterbunny wants to merge 2 commits into
Open
Conversation
boris91
approved these changes
Jun 5, 2026
| @@ -0,0 +1,73 @@ | |||
| name: Vale documentation lint | |||
|
|
|||
| on: | |||
Contributor
There was a problem hiding this comment.
Why not run this on PRs?
Suggested change
| on: | |
| on: | |
| pull_request: | |
| paths: ['**/*.md', '**/*.mdx'] |
| @@ -0,0 +1,114 @@ | |||
| # Vale configuration | |||
| # See vale_styles/README.md file for details and licensing information | |||
Contributor
There was a problem hiding this comment.
Shouldn't this README be part of the PR?
| - WAR | ||
| - WEI | ||
| - XML | ||
| - YAML|yaml |
Contributor
There was a problem hiding this comment.
Suggested change
| - YAML|yaml | |
| - YAML | |
| - yaml |
Comment on lines
+101
to
+102
| - loudly | ||
| - loudly |
Contributor
There was a problem hiding this comment.
Suggested change
| - loudly | |
| - loudly | |
| - loudly |
Comment on lines
+5
to
+13
| # This is not working | ||
| action: | ||
| name: replace | ||
| swap: | ||
| '′': "'" | ||
| '″': '"' | ||
| # Attempt same as unicode | ||
| "\u2032": "'" | ||
| "\u2033": '"' |
Contributor
There was a problem hiding this comment.
We may want to remove this until it is working.
| - Numbered lists stop | ||
| - Diataxis ia | ||
| - No positional references ("Swap the filename for any other model from the table” NOT "Swap the filename for any other model from the table above”) | ||
| - Links from relevent text NOT "see ..." (do "The [Worker install pattern][install-pattern] defines the per-Worker mechanics." NOT "See the Worker [install pattern][install-pattern] for the per-Worker mechanics.") |
Contributor
There was a problem hiding this comment.
Suggested change
| - Links from relevent text NOT "see ..." (do "The [Worker install pattern][install-pattern] defines the per-Worker mechanics." NOT "See the Worker [install pattern][install-pattern] for the per-Worker mechanics.") | |
| - Links from relevant text NOT "see ..." (do "The [Worker install pattern][install-pattern] defines the per-Worker mechanics." NOT "See the Worker [install pattern][install-pattern] for the per-Worker mechanics.") |
| - US English | ||
| - Bullet lists no stop (- Avalon not - Avalon.) | ||
| - Numbered lists stop | ||
| - Diataxis ia |
Contributor
There was a problem hiding this comment.
Suggested change
| - Diataxis ia | |
| - Diátaxis ia |
|
|
||
| 1. `## Overview` — one paragraph or `## How it works`+ "This page ... | ||
| 2. `## Next steps` — bullet list, each item `Description — [link](path)` | ||
| 1. `## Overview` or `## How it works`— one paragraph or sentence "This page ..." clarifying page's purpose |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. `## Overview` or `## How it works`— one paragraph or sentence "This page ..." clarifying page's purpose | |
| 1. `## Overview` or `## How it works` — one paragraph or sentence "This page ..." clarifying page's purpose |
Comment on lines
-249
to
-255
| ### Frontmatter and linking strategy | ||
|
|
||
| Links are from relevant text NOT "see ..." (do "The [Worker install pattern][install-pattern] defines the per-Worker mechanics." NOT "See the Worker [install pattern][install-pattern] for the per-Worker mechanics.") | ||
|
|
||
| Ask maintainer if the page you are building is to be ported to `tether.io`, if so follow reference-style link definitions plus routing comments: | ||
|
|
||
| /mdk-prv/docs/reference/maintainers/port-signals.md |
Contributor
There was a problem hiding this comment.
Why did we remove this?
| Vale is available for local documentation linting. Run `vale sync` before linting so Vale downloads the configured package styles into the gitignored `styles/` package directories. | ||
|
|
||
| Use the project vocabulary to check custom spelling. For example, Tether should pass, while Tehtr should fail. | ||
|
|
Contributor
There was a problem hiding this comment.
a short install vale snippet may be helpful here.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.