Skip to content

Improve prose linting#61

Merged
nscuro merged 1 commit intomainfrom
improve-prose-linting
May 5, 2026
Merged

Improve prose linting#61
nscuro merged 1 commit intomainfrom
improve-prose-linting

Conversation

@nscuro
Copy link
Copy Markdown
Member

@nscuro nscuro commented May 5, 2026

  • Adds a template to surface linting issues in a more readable format.
  • Adds a lint-prose-changed Make target that only lints modified files. Helpful because the full docs still have loads of issues.
  • Raises custom Vale rules from severity warning to error.
  • Fixes newly raised errors.

* Adds a template to surface linting issues in a more readable format.
* Adds a lint-prose-changed Make target that only lints modified files. Helpful because the full docs still have loads of issues.
* Raises custom Vale rules from severity warning to error.
* Fixes newly raised errors.

Signed-off-by: nscuro <nscuro@protonmail.com>
Copilot AI review requested due to automatic review settings May 5, 2026 22:56
@nscuro nscuro added the enhancement New feature or request label May 5, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR improves the documentation repo’s prose-linting workflow by making Vale output more readable, adding a target to lint only changed files, and tightening custom Vale rule severities (with accompanying doc edits to satisfy the stricter rules).

Changes:

  • Add a custom Vale output template and update make lint-prose to use it, with configurable minimum alert level and lint paths.
  • Add make lint-prose-changed to lint only Markdown files changed relative to the branch’s upstream reference.
  • Promote custom DependencyTrack Vale rules from warning → error and adjust various docs to comply (remove em-dashes, avoid “leverage”, etc.).

Reviewed changes

Copilot reviewed 16 out of 16 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
README.md Documents the new/updated lint targets, including lint-prose-changed.
Makefile Adds Vale configuration knobs, switches Vale to a custom output template, and introduces lint-prose-changed.
docs/reference/datasources/internal-components.md Prose tweak to avoid an em-dash by splitting into two sentences.
docs/reference/datasources/index.md Prose tweak to avoid an em-dash; introduces slightly awkward punctuation.
docs/reference/datasources/github-advisories.md Prose tweaks to avoid em-dashes and improve sentence structure.
docs/reference/configuration/datasources.md Rephrases tip text to be more direct/compact.
docs/reference/configuration/application.md Rephrases a tip and adds a targeted Vale suppression around “underscores”.
docs/guides/administration/configuring-database.md Replaces “leverage” with “use” for Vale compliance.
docs/concepts/architecture/design/vulnerability-analysis.md Minor rephrasing for clarity and to avoid flagged phrasing.
docs/concepts/architecture/design/durable-execution.md Multiple prose cleanups to avoid flagged phrases and improve clarity.
AGENTS.md Updates contributor guidance with lint-prose-changed and new Vale tuning env vars.
.vale/styles/DependencyTrack/EmDash.yml Raises rule severity to error.
.vale/styles/DependencyTrack/AITransitions.yml Raises rule severity to error.
.vale/styles/DependencyTrack/AIFillerPhrases.yml Raises rule severity to error.
.vale/styles/DependencyTrack/AIBuzzwords.yml Raises rule severity to error.
.vale/output.tmpl Adds a custom Vale output template to improve readability of lint results.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread Makefile
Comment thread docs/reference/datasources/index.md
@nscuro nscuro merged commit 8e61490 into main May 5, 2026
9 checks passed
@nscuro nscuro deleted the improve-prose-linting branch May 5, 2026 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants