Skip to content

docs(nx-cloud): initial polygraph docs #31657

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 23, 2025
Merged

docs(nx-cloud): initial polygraph docs #31657

merged 9 commits into from
Jun 23, 2025

Conversation

barbados-clemens
Copy link
Contributor

@barbados-clemens barbados-clemens commented Jun 20, 2025

Copy link

vercel bot commented Jun 20, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview Jun 23, 2025 10:28pm

Copy link

nx-cloud bot commented Jun 20, 2025

View your CI Pipeline Execution ↗ for commit ad1dee9.

Command Status Duration Result
nx affected --targets=lint,test,build,e2e,e2e-c... ✅ Succeeded 5m 8s View ↗
nx run-many -t check-imports check-commit check... ✅ Succeeded 18s View ↗
nx-cloud record -- nx-cloud conformance:check ✅ Succeeded 2s View ↗
nx-cloud record -- nx format:check ✅ Succeeded 7s View ↗
nx-cloud record -- nx sync:check ✅ Succeeded 5s View ↗
nx documentation ✅ Succeeded <1s View ↗

☁️ Nx Cloud last updated this comment at 2025-06-23 22:18:22 UTC

@barbados-clemens barbados-clemens force-pushed the docs/polygraph branch 2 times, most recently from 557d697 to 12b2eb5 Compare June 20, 2025 00:29
@barbados-clemens barbados-clemens self-assigned this Jun 20, 2025
@barbados-clemens barbados-clemens marked this pull request as ready for review June 20, 2025 01:38
@barbados-clemens barbados-clemens requested a review from Copilot June 20, 2025 01:39
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR introduces initial documentation for the Polygraph suite of Nx Enterprise features and updates existing Conformance docs to include Nx Enterprise references.

  • Added new Polygraph, Metadata-Only Workspaces, and Custom Workflows pages, plus sitemap and map.json entries.
  • Expanded Conformance plugin and feature docs to mention Nx Enterprise alongside Nx Powerpack.
  • Enhanced the Conformance Rules dashboard guide with two new overview sections.

Reviewed Changes

Copilot reviewed 11 out of 31 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/shared/reference/sitemap.md Added entries for Polygraph, Metadata-Only Workspaces, Custom Workflows
docs/shared/packages/conformance/create-conformance-rule.md Updated frontmatter to include Nx Enterprise
docs/shared/packages/conformance/conformance-plugin.md Expanded plugin description and license callout
docs/shared/features/powerpack/conformance.md Updated feature description and call-to-action for Nx Enterprise
docs/nx-cloud/enterprise/polygraph.md New Polygraph overview and feature guide
docs/nx-cloud/enterprise/metadata-only-workspace.md New Metadata-Only Workspaces guide
docs/nx-cloud/enterprise/custom-workflows.md New Custom Workflows guide
docs/nx-cloud/enterprise/conformance/configure-conformance-rules-in-nx-cloud.md Added detailed dashboard overview sections
docs/map.json Registered new Polygraph-related pages in the site map
docs/external-generated/packages/conformance/documents/overview.md Updated generated Conformance overview for Nx Enterprise
docs/external-generated/packages/conformance/documents/create-conformance-rule.md Updated generated Create Rule doc for Nx Enterprise
Comments suppressed due to low confidence (4)

docs/shared/reference/sitemap.md:872

  • The indentation for this entry doesn't match the surrounding items, which may break the sitemap hierarchy. Align its spaces to match existing sub-list items under Conformance.
      - [Polygraph](/ci/recipes/enterprise/polygraph)

docs/nx-cloud/enterprise/polygraph.md:21

  • [nitpick] Closing callout tags should include a space after {% for consistency ({% /callout %}) to match other callout syntax in the docs.
{%/callout %}

docs/nx-cloud/enterprise/metadata-only-workspace.md:38

  • [nitpick] Use a space after {% in the closing tag ({% /callout %}) to maintain consistent Liquid callout syntax across documentation.
{%/callout %}

docs/nx-cloud/enterprise/custom-workflows.md:26

  • [nitpick] Ensure closing callout tags use {% /callout %} (with a space) to match other examples and avoid template rendering issues.
{%/callout %}

@FrozenPandaz FrozenPandaz added the priority: medium Medium Priority (not high, not low priority) label Jun 23, 2025
@mhartington mhartington merged commit 0ef8857 into master Jun 23, 2025
5 of 6 checks passed
@mhartington mhartington deleted the docs/polygraph branch June 23, 2025 22:23
mhartington added a commit that referenced this pull request Jun 23, 2025
add docs over polygraph features

https://nx-dev-git-docs-polygraph-nrwl.vercel.app/ci/recipes/enterprise/polygraph

---------

Co-authored-by: Mike Hartington <mhartington@users.noreply.github.com>
Co-authored-by: graphite-app[bot] <96075541+graphite-app[bot]@users.noreply.github.com>
Co-authored-by: Mike Hartington <mikehartington@gmail.com>
(cherry picked from commit 0ef8857)
Copy link

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 29, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
priority: medium Medium Priority (not high, not low priority) type: docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants