docs(misc): add Vale as automated editor and a Claude skill to ensure style guide is followed#34744
Conversation
jaysoo
requested review from
a team,
Coly010,
FrozenPandaz and
vsavkin
as code owners
✅ Deploy Preview for nx-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for nx-dev ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
View your CI Pipeline Execution ↗ for commit ea12eb5
☁️ Nx Cloud last updated this comment at |
![nx-cloud[bot]](https://avatars.githubusercontent.com/in/80458?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
✅ The fix from Nx Cloud was applied
These changes fix the format:check failure by running nx format to apply Prettier formatting rules to the STYLE_GUIDE.md file. The table column widths in the terminology reference section have been adjusted to meet the workspace's formatting standards, ensuring all content adheres to consistent alignment requirements.
Warning
❌ We could not verify this fix.
Suggested Fix changes
diff --git a/astro-docs/STYLE_GUIDE.md b/astro-docs/STYLE_GUIDE.md
index ac83ac7569..01afdda3e4 100644
--- a/astro-docs/STYLE_GUIDE.md
+++ b/astro-docs/STYLE_GUIDE.md
@@ -365,25 +365,25 @@ Use tables for structured data that benefits from a matrix layout. For simple li
Use these terms consistently. When writing about Nx concepts, use the exact term from this list.
-| Term | Usage notes |
-| -------------- | ------------------------------------------------------------------------------------------------- |
-| workspace | The root directory managed by Nx. Not "repo" or "monorepo" when referring to Nx's context. |
-| project | An app or library within the workspace. |
-| target | A task that can be run for a project (e.g., `build`, `test`, `lint`). |
-| executor | The implementation behind a target. Not "builder." |
-| generator | Code scaffolding tool. Not "schematic." |
-| plugin | An Nx plugin that provides executors, generators, or graph inference. |
-| task | A specific invocation of a target for a project (e.g., `myapp:build`). |
-| project graph | The dependency graph between projects. |
-| affected | Projects impacted by a code change. |
-| cache / cached | Not "memoized" or "stored results." |
-| remote caching | Sharing cached results across machines. Specific product: "Nx Replay." |
-| Nx Cloud | The hosted CI/CD product. Always capitalized. |
-| Nx Console | The IDE extension. Always capitalized. |
-| Nx Agents | Distributed task execution product. Always capitalized. |
-| Nx Replay | Remote caching product. Always capitalized. |
-| `nx.json` | Always in code style. |
-| `project.json` | Always in code style. |
+| Term | Usage notes |
+| -------------- | ------------------------------------------------------------------------------------------ |
+| workspace | The root directory managed by Nx. Not "repo" or "monorepo" when referring to Nx's context. |
+| project | An app or library within the workspace. |
+| target | A task that can be run for a project (e.g., `build`, `test`, `lint`). |
+| executor | The implementation behind a target. Not "builder." |
+| generator | Code scaffolding tool. Not "schematic." |
+| plugin | An Nx plugin that provides executors, generators, or graph inference. |
+| task | A specific invocation of a target for a project (e.g., `myapp:build`). |
+| project graph | The dependency graph between projects. |
+| affected | Projects impacted by a code change. |
+| cache / cached | Not "memoized" or "stored results." |
+| remote caching | Sharing cached results across machines. Specific product: "Nx Replay." |
+| Nx Cloud | The hosted CI/CD product. Always capitalized. |
+| Nx Console | The IDE extension. Always capitalized. |
+| Nx Agents | Distributed task execution product. Always capitalized. |
+| Nx Replay | Remote caching product. Always capitalized. |
+| `nx.json` | Always in code style. |
+| `project.json` | Always in code style. |
## Vale configuration
🔔 Heads up, your workspace has pending recommendations ↗ to auto-apply fixes for similar failures.
➡️ This fix was applied by Jack Hsu
🎓 Learn more about Self-Healing CI on nx.dev
AgentEnder
approved these changes
Mar 6, 2026
![graphite-app[bot]](https://avatars.githubusercontent.com/in/158384?s=60&v=4){kind=small}
Comment on lines
+15
to
+17
| } catch (err) { | ||
| process.exit(err.status === 1 ? 1 : 0); | ||
| } |
Contributor
There was a problem hiding this comment.
Error handling treats all non-1 exit codes as success, which will hide real failures like Vale not being installed (exit 127) or configuration errors. Vale can exit with codes other than 0, 1, or 2.
} catch (err) {
// Only exit 1 for Vale errors (status 1)
// Exit 0 for warnings only (status 2)
// For other errors (missing binary, config issues), re-throw
if (err.status === 1) {
process.exit(1);
} else if (err.status === 2) {
process.exit(0);
} else {
throw err;
}
}
Suggested change
| } catch (err) { | |
| process.exit(err.status === 1 ? 1 : 0); | |
| } | |
| } catch (err) { | |
| // Only exit 1 for Vale errors (status 1) | |
| // Exit 0 for warnings only (status 2) | |
| // For other errors (missing binary, config issues), re-throw | |
| if (err.status === 1) { | |
| process.exit(1); | |
| } else if (err.status === 2) { | |
| process.exit(0); | |
| } else { | |
| throw err; | |
| } | |
| } |
Spotted by Graphite
Is this helpful? React 👍 or 👎 to let us know.
barbados-clemens
approved these changes
Mar 6, 2026
jaysoo
force-pushed
the
DOC-393
branch
3 times, most recently
from
c05bc55 to
43fb6cb
Compare
… style guide is followed
Contributor
|
This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 participants
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.
This PR makes it much easier for everyone to contribute to our docs.
mise- This is our automated editor.astro-docs/STYLE_GUIDE.mdfor things that Vale cannot pick up.CLAUDE.mdinstruction to invoke the skill (2) whenever someone is updating docs.Demo: https://www.loom.com/share/415a9da056d3483da297fda61f7e7382