Repository navigation
Bump vale-ai-tells to v1.37.0 - #507
Merged
Merged
Conversation
|
Docs preview: https://modelplane-docs-pr-507.vercel.app (ready once the site's Content workflow finishes) |
v1.19.0 has 60 rules and v1.37.0 has 137. The new rules raise 172 errors in docs that pass the docs-vale check today, and this commit leaves them unfixed. Unlike v1.19.0, v1.37.0 ships a config/ directory. Copied out of the store read-only, it blocked the lint step from merging the repo's vocabularies into config/. Signed-off-by: Nic Cope <nicc@rk0n.org>
The v1.37.0 rules flag 172 sentences across the docs. This rewrites each one rather than suppressing the rule, so docs-vale passes without new inline exceptions. A few flagged sentences were also inaccurate, such as a CEL selector described as a single line and a scheduler rule limited to healthy replicas, and the rewrites correct them. Three headings change, and so do their anchors: "How a service reaches its gateways", "How a deployment is composed", and "What the control plane reconciles". Nothing in this repo links to them. Signed-off-by: Nic Cope <nicc@rk0n.org>
There was a problem hiding this comment.
🟢 Approval recommended
The documentation and lint-workflow changes are narrowly scoped, with no identified blocking issues.
0 open findings
What changed in this PR
Updates Modelplane’s documentation linting to vale-ai-tells v1.37.0 and revises prose to satisfy the expanded rules.
Changes:
- Upgrades the Vale package pin and corresponding Nix hash.
- Makes copied styles writable so repository vocabularies can merge.
- Rewrites flagged documentation without adding inline exceptions.
| File | Description |
|---|---|
| nix/docs.nix | Updates styles hash and copy permissions. |
| docs/utils/vale/.vale.ini | Pins vale-ai-tells v1.37.0. |
| docs/content/recipes/qwen3-coder.md | Revises deployment descriptions. |
| docs/content/recipes/qwen3-8b.md | Revises hardware and speculation wording. |
| docs/content/recipes/qwen2.5-7b.md | Clarifies hardware and regional availability. |
| docs/content/recipes/qwen2.5-72b.md | Revises placement and comparison prose. |
| docs/content/recipes/nemotron-3.5-lightning.md | Revises serving configuration prose. |
| docs/content/recipes/llama-3.1-8b.md | Clarifies placement and setup wording. |
| docs/content/recipes/laguna.md | Revises topology descriptions. |
| docs/content/recipes/kimi-k2.md | Clarifies reservation placeholder instructions. |
| docs/content/recipes/glm-4.5-air.md | Revises engine configuration prose. |
| docs/content/platform/telemetry.md | Revises metrics and exporter explanations. |
| docs/content/platform/providers.md | Clarifies prospective provider integration. |
| docs/content/platform/inference-gateway.md | Revises gateway configuration wording. |
| docs/content/platform/inference-cluster.md | Clarifies load-balancer and weight-transfer prose. |
| docs/content/platform/inference-class.md | Revises device attribute explanations. |
| docs/content/platform/drain-cluster.md | Clarifies drain and toleration wording. |
| docs/content/overview/why.md | Revises fleet-management descriptions. |
| docs/content/overview/how-it-works.md | Revises reconciliation and topology explanations. |
| docs/content/overview/glossary.md | Refines control-plane and fleet definitions. |
| docs/content/overview/faq.md | Simplifies introductory answers. |
| docs/content/overview/ai-tools.md | Revises documentation access explanations. |
| docs/content/overview/_index.md | Simplifies GPU scale wording. |
| docs/content/models/model-service.md | Revises routing and timeout guidance. |
| docs/content/models/model-endpoint.md | Simplifies endpoint definition. |
| docs/content/models/model-deployment.md | Revises topology, selector, and sizing guidance. |
| docs/content/models/model-cache.md | Revises caching and loading explanations. |
| docs/content/install/_index.md | Clarifies installation and readiness wording. |
| docs/content/guides/serving-multi-node-on-dynamo.md | Clarifies worker rank and scaling prose. |
| docs/content/guides/anthropic-messages-api.md | Simplifies GPU count wording. |
| docs/content/getting-started/scale-the-platform.md | Simplifies endpoint wording. |
| docs/content/getting-started/scale-the-model.md | Revises regional scaling and recap prose. |
| docs/content/getting-started/deploying-a-model.md | Revises team responsibility recap. |
| docs/content/getting-started/clean-up.md | Clarifies deletion ordering explanations. |
| docs/content/getting-started/build-the-platform.md | Clarifies credential and permission guidance. |
| docs/content/getting-started/_index.md | Refines placement behavior explanation. |
| docs/content/architecture/scheduling.md | Revises matching and capacity explanations. |
| docs/content/architecture/_index.md | Revises Crossplane architecture prose. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
tr0njavolta
approved these changes
Oct 7, 2026
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.
Description of your changes
We lint the docs with
vale-ai-tellsv1.19.0, which has 60 rules. The latest release, v1.37.0, has 137. I noticed the gap while reviewing modelplaneai/website#39: our docs Vale config found no AI writing patterns in that blog post, but with v1.37.0 it found 11.This PR bumps the pin, then rewrites the 172 sentences the new rules flag in the current docs, across 40 rules. The first commit alone fails
docs-vale, and the table below shows what it caught. The second commit fixes them without adding inline exceptions.Errors by rule
v1.37.0 also includes a
config/directory. The lint step copied it out of the Nix store read-only, then failed when it merged the repo's vocabularies into it, sonix/docs.nixnow copies the synced styles without their mode bits.I have:
nix flake check(or./nix.sh flake check) and made sure it passes.Added or updated tests covering any composition function changes.git commit -s.