From 6dc34db9da78a6a8507077186f0e27eda0c3bd58 Mon Sep 17 00:00:00 2001 From: koliveira15 Date: Thu, 23 May 2024 12:05:32 -0400 Subject: [PATCH 1/2] docs: compatibility doc --- .../content/docs/reference/compatibility.mdx | 21 +++++++++++++++++++ packages/nx-sonarqube/README.md | 4 +--- 2 files changed, 22 insertions(+), 3 deletions(-) create mode 100644 apps/docs-site/src/content/docs/reference/compatibility.mdx diff --git a/apps/docs-site/src/content/docs/reference/compatibility.mdx b/apps/docs-site/src/content/docs/reference/compatibility.mdx new file mode 100644 index 0000000..f9e7eae --- /dev/null +++ b/apps/docs-site/src/content/docs/reference/compatibility.mdx @@ -0,0 +1,21 @@ +--- +title: Compatibility +--- + +import {Code} from '@astrojs/starlight/components'; +export const output = `{ + '@nx/devkit': '>= 16 < 19', + '@phenomnomnominal/tsquery': '5.0.1', + 'sonarqube-scanner': '3.1.0', + nx: '>= 16 < 20', + tslib: '>= 2.3.0 < 3 +}` + +For compatibilities with Nx versions, you can check the [Releases](https://github.com/koliveira15/nx-sonarqube/releases) +page in GitHub or run the following command where `x.x.x` is the semver version of the package: + +```shell +npm info @koliveira15/nx-sonarqube@x.x.x peerDependencies +``` + + diff --git a/packages/nx-sonarqube/README.md b/packages/nx-sonarqube/README.md index 781b4f0..9567c07 100644 --- a/packages/nx-sonarqube/README.md +++ b/packages/nx-sonarqube/README.md @@ -1,5 +1,3 @@ # @koliveira15/nx-sonarqube -![logo](https://i.ibb.co/R0bzqtP/nx-sonarqube.png) - -[See Documentation](https://github.com/koliveira15/nx-sonarqube) +[Documentation](https://nx-sonarqube.dev/) From b127205813eadc435d6094035801e1fb44fa37c8 Mon Sep 17 00:00:00 2001 From: koliveira15 Date: Thu, 23 May 2024 12:05:45 -0400 Subject: [PATCH 2/2] docs: compatibility doc --- apps/docs-site/src/content/docs/reference/compatibility.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/apps/docs-site/src/content/docs/reference/compatibility.mdx b/apps/docs-site/src/content/docs/reference/compatibility.mdx index f9e7eae..d76ace7 100644 --- a/apps/docs-site/src/content/docs/reference/compatibility.mdx +++ b/apps/docs-site/src/content/docs/reference/compatibility.mdx @@ -2,14 +2,14 @@ title: Compatibility --- -import {Code} from '@astrojs/starlight/components'; +import { Code } from '@astrojs/starlight/components'; export const output = `{ '@nx/devkit': '>= 16 < 19', '@phenomnomnominal/tsquery': '5.0.1', 'sonarqube-scanner': '3.1.0', nx: '>= 16 < 20', tslib: '>= 2.3.0 < 3 -}` +}`; For compatibilities with Nx versions, you can check the [Releases](https://github.com/koliveira15/nx-sonarqube/releases) page in GitHub or run the following command where `x.x.x` is the semver version of the package: @@ -18,4 +18,4 @@ page in GitHub or run the following command where `x.x.x` is the semver version npm info @koliveira15/nx-sonarqube@x.x.x peerDependencies ``` - +