Skip to content

Commit

Permalink
Name docs files better.
Browse files Browse the repository at this point in the history
Signed-off-by: Mirjam Aulbach <[email protected]>
  • Loading branch information
programmiri committed Sep 26, 2023
1 parent b4e0773 commit 2a22846
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion .github/vale/vale.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ When you have Vale installed, you can run this scripts on root level:
- what files to check (`.md` and `.mdx` files)
- what styles to use ([Google package](https://vale.sh/hub/google/) as well as custom Klaw styles)

The GitHub workflow is defined in [`.github/workflows/vale.yaml`](/.github/workflows/vale.yaml)
The GitHub workflow is defined in [`.github/workflows/vale.yaml`](../workflows/vale.yaml)

### Spell checking

Expand Down
6 changes: 3 additions & 3 deletions markdown-link-check-script/markdown-link-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ order to use them.
### ➡️ `npm run markdown-link-check`

Will run the check for all Markdown files. It checks internal as well as external links (so it needs internet
connection) and assets. Please be aware that you need to [check your results](#-limitation)
connection) and assets. Please be aware that you need to [check your results](#limitation)

### ➡️ `npm run markdown-link-check -f "path/to/file.md`

Expand All @@ -27,9 +27,9 @@ connection) and assets.

The flags can be used with all files as well as only one. They can also be used together.

## ⚠️ Limitation
## Limitation

When running the link-check for all files without the offline mode flag, the first command ("Checking links in all
⚠️ When running the link-check for all files without the offline mode flag, the first command ("Checking links in all
markdown files in /docs") will always return an exist code `1`. We've investigated that for quite some time, but not
found out what the issue is. Since we're only using offline mode in CI, we decided that we can live with that for now,
as we still can run the checks and get all result.

0 comments on commit 2a22846

Please sign in to comment.