- Notifications
You must be signed in to change notification settings - Fork2.6k
docs(nx-cloud): update docs for conformance v4#32988
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:master
Are you sure you want to change the base?
Conversation
vercelbot commentedOct 7, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
The latest updates on your projects. Learn more aboutVercel for GitHub.
|
netlifybot commentedOct 7, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
✅ Deploy Preview fornx-docs ready!
To edit notification comments on pull requests, go to yourNetlify project configuration. |
nx-cloudbot commentedOct 7, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
View yourCI Pipeline Execution ↗ for commit50767a9
☁️Nx Cloud last updated this comment at |
nx-cloudbot left a comment• edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Nx Cloud is proposing a fix for your failed CI:
We've fixed the broken documentation links for the new conformance testing guide. The PR created a file namedtest-conformance-rule.mdoc
but the links were pointing totesting-conformance-rules
. Updated three documentation files to use the correct URL path/docs/reference/powerpack/conformance/test-conformance-rule
.
We verified this fix by re-runningastro-docs:validate-links
.
Suggested Fix changes
diff --git a/astro-docs/src/content/docs/enterprise/Powerpack/conformance.mdoc b/astro-docs/src/content/docs/enterprise/Powerpack/conformance.mdocindex ce74dc074a..267977fe90 100644--- a/astro-docs/src/content/docs/enterprise/Powerpack/conformance.mdoc+++ b/astro-docs/src/content/docs/enterprise/Powerpack/conformance.mdoc@@ -127,7 +127,7 @@ Learn more about [publishing](/docs/enterprise/powerpack/publish-conformance-rul - [Conformance Plugin API Reference](/docs/reference/powerpack/conformance/overview) - Detailed documentation on configuration options and provided rules - [Create a Custom Conformance Rule](/docs/reference/powerpack/conformance/create-conformance-rule) - Step-by-step guide to writing your own rules-- [Testing Conformance Rules](/docs/reference/powerpack/conformance/testing-conformance-rules) - Learn how to test your conformance rules+- [Testing Conformance Rules](/docs/reference/powerpack/conformance/test-conformance-rule) - Learn how to test your conformance rules - [Publish Conformance Rules to Nx Cloud](/docs/enterprise/powerpack/publish-conformance-rules-to-nx-cloud) - Share rules across your organization - [Configure Conformance Rules in Nx Cloud](/docs/enterprise/powerpack/configure-conformance-rules-in-nx-cloud) - Manage rules via the Nx Cloud dashboard - [Blog: Automating Consistency with Nx Cloud Conformance](https://nx.dev/blog/nx-cloud-conformance-automate-consistency) - Learn about the philosophy and benefits of conformancediff --git a/astro-docs/src/content/docs/reference/Powerpack/conformance/create-conformance-rule.mdoc b/astro-docs/src/content/docs/reference/Powerpack/conformance/create-conformance-rule.mdocindex 0ea9e56917..56c6622b62 100644--- a/astro-docs/src/content/docs/reference/Powerpack/conformance/create-conformance-rule.mdoc+++ b/astro-docs/src/content/docs/reference/Powerpack/conformance/create-conformance-rule.mdoc@@ -69,7 +69,7 @@ Note that the severity of the error is defined by the rule author and can be adj The rule implementation is passed a `context` object which contains:-- **`tree`**: A `ReadOnlyConformanceTree` that can be used to read files from the workspace instead of directly from disk. Useful for unit testing rules as a test tree can be provided to the rule implementation (see [Testing Conformance Rules](/docs/reference/powerpack/conformance/testing-conformance-rules)).+- **`tree`**: A `ReadOnlyConformanceTree` that can be used to read files from the workspace instead of directly from disk. Useful for unit testing rules as a test tree can be provided to the rule implementation (see [Testing Conformance Rules](/docs/reference/powerpack/conformance/test-conformance-rule)). - **`projectGraph`**: The Nx project graph - **`fileMapCache`**: The Nx file map cache - **`ruleOptions`**: The resolved rule configuration options based on the current workspacediff --git a/astro-docs/src/content/docs/reference/Powerpack/conformance/overview.mdoc b/astro-docs/src/content/docs/reference/Powerpack/conformance/overview.mdocindex 99a0d84a47..7abbe4e36c 100644--- a/astro-docs/src/content/docs/reference/Powerpack/conformance/overview.mdoc+++ b/astro-docs/src/content/docs/reference/Powerpack/conformance/overview.mdoc@@ -271,6 +271,6 @@ Both types of `fixGeneratorData` are automatically stripped from the final repor For more information about the conformance plugin, consult the following articles: - [Create a Conformance Rule](/docs/reference/core-api/conformance/documents/create-conformance-rule)-- [Testing Conformance Rules](/docs/reference/core-api/conformance/documents/testing-conformance-rules)+- [Testing Conformance Rules](/docs/reference/powerpack/conformance/test-conformance-rule) - [Publish Conformance Rules to Nx Cloud](/docs/enterprise/powerpack/publish-conformance-rules-to-nx-cloud) - [Configure Conformance Rules in Nx Cloud](/docs/enterprise/powerpack/configure-conformance-rules-in-nx-cloud)
Apply fix locally ↗ View interactive diff ↗
⚙️ An Nx Cloud workspace admin can disable these reviewsin workspace settings.
these links redirect when deployed with nextjs side, but still wanted tomove off them anyway
f5125ff
to50767a9
Compare
update docs to include information over conformance v4 including new testing guide
fixes DC226