docs(tools): add Vale prose linter section #23
Merged
Conversation
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
gwtaylor
force-pushed
the
docs/add-vale-section
branch
from
4f47eb2 to
1ea3da4
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Adds documentation for Vale (a prose/style linter) to help contributors lint and standardize project documentation.
Changes:
- Introduces a new “Vale” subsection under “Formatting and Linting”.
- Documents macOS installation, basic CLI usage, and
.vale.iniconfiguration. - Mentions integration options via pre-commit and GitHub workflows.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
egrace479
reviewed
Jan 28, 2026
Member
egrace479
left a comment
egrace479
left a comment
There was a problem hiding this comment.
Looks great, thanks! Just two small suggestions.
Co-authored-by: Elizabeth Campolongo <38985481+egrace479@users.noreply.github.com>
Contributor
* 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>
Collaborator
Author
|
@egrace479 I accepted your suggestion (thanks!) and added hyperlinks to the suggested Vale styles. Ready for your approval! |
egrace479
added a commit
to Imageomics/Imageomics-guide
that referenced
this pull request
Jan 29, 2026
Pull from Collab Guide [PR 23](Imageomics/Collaborative-distributed-science-guide#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>
egrace479
added a commit
to ABC-Center/ABC-guide
that referenced
this pull request
Jan 29, 2026
Pull from Collab Guide [PR 23](Imageomics/Collaborative-distributed-science-guide#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>
egrace479
added a commit
to ABC-Center/ABC-guide
that referenced
this pull request
Jan 29, 2026
Pull from Collab Guide [PR 23](Imageomics/Collaborative-distributed-science-guide#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>
egrace479
added a commit
to Imageomics/Imageomics-guide
that referenced
this pull request
Jan 29, 2026
Pull from Collab Guide [PR 23](Imageomics/Collaborative-distributed-science-guide#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>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Adds a new section about Vale, a syntax-aware prose linter for documentation and markdown files.
The new section: