mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
Ethan Palm
5cfff0fdd4
* Fix Vale rules instead of degrading prose
The Vale style audit workflow told the agent to make warnings go away,
with only two outcomes: fix the prose or note it in the PR body. That
produced runs that reworded correct English to satisfy an over-matching
rule, and one that replaced em dashes with colons when Mintlify.EmDash
only bans the spaces around them.
- Add a third classification to the workflow: when the prose is correct
and the rule is over-matching, fix the rule. Documents where to make
each kind of rule fix and requires explaining it in the PR body.
- Replace the "warnings left by the CI check" step. There is no Vale CI
check in this repo, so the step pointed at a source that does not
exist. Run vale against the changed files instead.
- Resolve the "a pull request for each file" ambiguity to one PR.
- Narrow the WordList `above` pattern so tier comparisons ("Pro plan and
above") are exempt. Positional references ("see above", "the app ID
above") still flag. The \b guard keeps words ending in "and" such as
"command above" and "operand above" flagged.
Verified with vale 3.12.0 against a fixture covering both the wrongly
flagged text and the text the rule must still catch.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Fold vocabulary maintenance into the weekly Vale audit
Update Vale vocabulary ran on every merge to main: six runs in about
three hours on Aug 10, four of them no-ops, and it split related terms
across separate runs because each run only saw one PR. The work also has
an ordering dependency on the style audit, which should not reword a
valid product name that the vocabulary pass ought to accept.
Adds the vocabulary pass as step 4 of the weekly audit, ahead of prose
fixes, and notes that accept.txt entries are case-sensitive regular
expressions. The previous instruction to find words "not already
present" invited a literal comparison, which would add "allowlisted" as
a new line even though allowlist(s|ed|ing)? already covers it.
Update Vale vocabulary is disabled rather than deleted; its file stays in
.mintlify/workflows/ for now.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
* Deprecate local workflow files; dashboard is source of truth
The .mintlify/workflows/ files had already drifted out of sync with the
automations they were supposed to define, in both directions:
- translation-lag.md was missing the entire "Check translated redirect
parity" section that exists in the dashboard record. Had a file sync
fired, it would have reverted that work.
- seo-audit.md defined an automation, "SEO and metadata audit" on a
Monday cron, that has no dashboard record and has never run. It was
still being maintained through PRs as recently as #5250.
Keeping two sources of truth for the same automation invites silent
reverts and edits to prompts that do not run. The dashboard is now the
only definition. Full backup of the four file-backed records is in the
session scratchpad; all prompt text remains in git history.
seo-audit.md is dropped rather than recreated. Fix SEO issues covers it.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com>