Skip to content

Commit 73e44cb

Browse files
authored
chore: remove Vale from review-docs skill (#2636)
Vale cannot be shipped like mdlint, so invoking it per-file in this skill was dead weight. Vale still runs as a repo-level PR check and via the TW's local editor extension; the delegated standards review covers prose-style ground for the skill itself.
1 parent 4d1dbf6 commit 73e44cb

2 files changed

Lines changed: 5 additions & 3 deletions

File tree

.agents/skills/review-docs/SKILL.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,9 @@ argument-hint: file-path
1313
1. **Verify file version** - `git status` to confirm you have the latest
1414
2. **Run deterministic checks** (main process) - these are objective, no judgment needed:
1515
- `pnpm lint:md` (heading hierarchy, list numbering, spacing)
16-
- `vale "<file>" --minAlertLevel=error` (prose style, pronouns, dashes, code fences, admonitions)
1716
- `.agents/skills/review-docs/scripts/check-frontmatter.sh "<file>"` (description char count)
17+
18+
Vale runs separately as a repo-level PR check and via the TW's local editor extension - don't invoke it here. The delegated standards review (step 3) covers the same prose-style ground.
1819
3. **Delegated standards review** - spawn one subagent per standards file to check compliance. Each subagent reads the file being reviewed plus one standards file, and returns violations with line numbers and suggested fixes:
1920
- Subagent 1: check against `standards/writing-style.md` (voice, tone, headings, links)
2021
- Subagent 2: check against `standards/content-standards.md` (front matter, admonitions, code blocks)

.agents/skills/review-docs/references/process.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,10 @@ Agent-agnostic workflow for reviewing Apify documentation.
1212
These are objective - no judgment needed. Report all failures. Run in the main process (not in subagents).
1313

1414
- `pnpm lint:md` (markdownlint: heading hierarchy, double spaces, list numbering)
15-
- `vale "<file>" --minAlertLevel=error` (prose style, dashes, code fences, admonitions)
1615
- `.agents/skills/review-docs/scripts/check-frontmatter.sh "<file>"` (description char count)
1716

17+
Vale is not part of this skill. It runs as a repo-level PR check and via the TW's local editor extension, but devs aren't expected to install it, so shipping it in the per-file review flow would create dead weight. Prose-style coverage comes from the delegated standards review in step 3.
18+
1819
## Step 3: Delegated standards review
1920

2021
Spawn one subagent per standards file to check compliance in parallel. Each subagent reads the file being reviewed plus one standards file, and returns violations with line numbers and suggested fixes.
@@ -60,4 +61,4 @@ Check that both JavaScript and Python examples are present and functionally equi
6061

6162
### Markdownlint false positives on admonitions
6263

63-
Markdownlint doesn't understand Docusaurus `:::` syntax natively. Check `.markdownlint.json` for configured exceptions. Focus on Vale for prose quality.
64+
Markdownlint doesn't understand Docusaurus `:::` syntax natively. Check `.markdownlint.json` for configured exceptions. Rely on the delegated standards review for prose-style judgment.

0 commit comments

Comments
 (0)