Skip to content

Commit d41b102

Browse files
gwtaylorCopilotegrace479Copilot
authored
docs(tools): add Vale prose linter section (#23)
* docs(tools): add Vale prose linter section * Update docs/wiki-guide/Helpful-Tools-for-your-Workflow.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/wiki-guide/Helpful-Tools-for-your-Workflow.md Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> * Add hyperlinks to Vale style guides in documentation (#56) * Initial plan * Add hyperlinks to Vale style guides (Google, Microsoft, write-good) Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com> Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: gwtaylor <993736+gwtaylor@users.noreply.github.com>
1 parent f386d71 commit d41b102

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

docs/wiki-guide/Helpful-Tools-for-your-Workflow.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,26 @@ Ruff can also be set up as part of a pre-commit hook or GitHub Workflow. See the
5656

5757
Fast _Markdown_ formatter and linter. We use the [DavidAnson/markdownlint](https://github.com/DavidAnson/markdownlint) package for this site; see instructions and example in the [linting section](https://github.com/Imageomics/Collaborative-distributed-science-guide/blob/main/CONTRIBUTING.md#linting) of our contributing guidelines. It is flexible in configuration and allows for simple checking or even fixing straight-forward formatting issues.
5858

59+
### Vale
60+
61+
Syntax-aware prose linter for documentation, technical writing, and Markdown files. Unlike basic spell checkers, [errata-ai/vale](https://github.com/errata-ai/vale) enforces customizable style guides and writing rules, making it ideal for maintaining consistency across project documentation. You can install it with `brew install vale` on macOS, or see the [installation guide](https://vale.sh/docs/vale-cli/installation/) for other platforms.
62+
63+
Vale comes with support for popular style guides like [Google](https://github.com/errata-ai/Google), [Microsoft](https://github.com/errata-ai/Microsoft), and [write-good](https://github.com/errata-ai/write-good), and you can create custom rules for your project's specific needs. It integrates well with version control workflows and can check documentation in various formats including Markdown, reStructuredText, HTML, and AsciiDoc.
64+
65+
To lint documentation files, run:
66+
67+
```bash
68+
vale <path/to/file.md>
69+
```
70+
71+
To check an entire directory:
72+
73+
```bash
74+
vale docs/
75+
```
76+
77+
Vale uses a `.vale.ini` configuration file in your project root to specify style guides, vocabulary, and which files to check. You can also set up Vale as part of a [pre-commit](https://pre-commit.com/) hook or GitHub Workflow to automatically check documentation on commits or pull requests. See the [Vale documentation](https://vale.sh/docs/) for configuration examples and style guide options.
78+
5979
## FAIR Data Access and Validation
6080

6181
Don't add to the reproducibility crisis! Are you using existing data accessed through URLs and need to ensure consistency for re-use? Do you have a folder of images with all their metadata documented through their filenames? [Cautious Robot](#cautious-robot) and [Sum Buddy](#sum-buddy) are here to help.

0 commit comments

Comments
 (0)