Skip to content

docs: synchronizing README from snyk/user-docs#6403

Open
team-cli-bot wants to merge 1 commit intomainfrom
docs/automatic-gitbook-update-readme-main
Open

docs: synchronizing README from snyk/user-docs#6403
team-cli-bot wants to merge 1 commit intomainfrom
docs/automatic-gitbook-update-readme-main

Conversation

@team-cli-bot
Copy link
Contributor

Automatic PR controlled by GitHub Action

@team-cli-bot team-cli-bot requested review from a team as code owners December 22, 2025 09:12
To use the CLI, you must install it and authenticate your machine. See [Install or update the Snyk CLI](https://docs.snyk.io/snyk-cli/install-or-update-the-snyk-cli) and [Authenticate the CLI with your account](authenticate-to-use-the-cli.md). You can refer to the [release notes](https://github.com/snyk/cli/releases) for a summary of changes in each release. Before scanning your code, review the [Code execution warning for Snyk CLI](https://docs.snyk.io/snyk-cli/code-execution-warning-for-snyk-cli).

**Note:** Before you can use the CLI for Open Source scanning, you must install your package manager. The needed third-party tools, such as Gradle or Maven, must be in the `PATH`.
{% hint style="info" %}
Copy link
Contributor

Choose a reason for hiding this comment

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

This one looks odd.

@CatalinSnyk
Copy link
Contributor

Hey @aluca3, could you take a look at the comment I left? This update seems to introduce some new templating in the markdown file that does not play out really well in our repo.

@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch from a5b55c2 to e65aa3a Compare December 29, 2025 09:12
@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch from e65aa3a to 72b6cea Compare January 5, 2026 09:13
@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch from 72b6cea to 2078cba Compare January 12, 2026 09:13
@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch from 2078cba to adfa8d4 Compare January 19, 2026 09:15
@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch from adfa8d4 to 87c0f6d Compare January 26, 2026 09:15
@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch from 87c0f6d to 7a697ac Compare February 2, 2026 09:22
@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch 2 times, most recently from 6de48ab to b892bc5 Compare February 16, 2026 09:25
@github-actions github-actions bot force-pushed the docs/automatic-gitbook-update-readme-main branch from b892bc5 to 372d8b6 Compare February 23, 2026 09:25
@snyk-io
Copy link

snyk-io bot commented Feb 23, 2026

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues
Licenses 0 0 0 0 0 issues
Code Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

@snyk-pr-review-bot
Copy link

PR Reviewer Guide 🔍

🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Formatting Regression 🟡 [minor]

The PR replaces a standard Markdown **Note:** prefix with GitBook-specific tags {% hint style="info" %} and {% endhint %}. These tags are not part of GitHub Flavored Markdown (GFM) and will render as literal text when viewed on GitHub, which degrades the readability of the primary documentation for the repository. While these tags work in the GitBook-based user-docs source, the root README.md on GitHub should ideally maintain compatibility with standard Markdown.

{% hint style="info" %}
Before you can use the CLI for Open Source scanning, you must install your package manager. The needed third-party tools, such as Gradle or Maven, must be in the `PATH`.
{% endhint %}
📚 Repository Context Analyzed

This review considered 6 relevant code sections from 5 files (average relevance: 0.82)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants