chore: add Vale prose-linting config - #259
Open
iabaako wants to merge 1 commit into
Open
Conversation
Adds .vale.ini configuring the Microsoft and IPA style packages for markdown/quarto docs, per IPA's writing guidelines. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a Vale configuration file to enable prose linting for Markdown/Quarto documentation using the Microsoft style package and intended IPA guidelines.
Changes:
- Adds
.vale.iniwith a configuredStylesPath,MinAlertLevel, and Markdown/Quarto format association. - Enables Microsoft styles and configures per-format style application and rule overrides.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -0,0 +1,40 @@ | |||
| # docs: https://vale.sh/docs/topics/config/ | |||
| StylesPath = assets/writing-styles | |||
Comment on lines
+6
to
+15
| Packages = Microsoft | ||
|
|
||
| [formats] | ||
| # Format associations appear under | ||
| # the optional "formats" section. | ||
| qmd = md | ||
|
|
||
| # docs: IPA Writing Guidelines https://ipastorage.box.com/shared/static/exej2k7pzsr9clr9hxdie70zaiv78j2k.docx | ||
| [*.{md,qmd}] | ||
| BasedOnStyles = IPA, Microsoft |
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
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.
Summary
.vale.iniconfiguring the Microsoft and IPA style packages for markdown/quarto docs, per IPA's writing guidelines.Test plan
🤖 Generated with Claude Code