Skip to content

docs: apply Snyk writing-style skill to Scan, fix, and prevent pages#1370

Open
TashaTBaker wants to merge 1 commit into
writing-style-reviewfrom
style-review/scan-fix-and-prevent
Open

docs: apply Snyk writing-style skill to Scan, fix, and prevent pages#1370
TashaTBaker wants to merge 1 commit into
writing-style-reviewfrom
style-review/scan-fix-and-prevent

Conversation

@TashaTBaker

Copy link
Copy Markdown
Contributor

Applies the Snyk documentation writing-style rules across the Scan, fix, and prevent section (239 files).

Part of the per-section writing-style review. Targets the shared base branch writing-style-review.

Excludes the Snyk API & Web pages (scan-with-snyk/snyk-api-web/, 134 files), which were styled separately on the api-and-web-style-review branch.

Consistent changes

  • Passive to active voice; present tense over future "will"
  • Capability phrasing: "allows/enables you to" to "lets you"; "is able to" to "can"
  • once to after; in order to to "to"; via to through/using; make sure to ensure; removed filler (just, simply, easily, currently)
  • Bold UI labels without element-type nouns; dropdown; check box "select/clear"
  • Spell out one-nine; commas in thousands; Projects/Organizations/Groups casing
  • Removed brand possessives, AI buzzwords, "(s)" plurals; fixed obvious typos

Preserved

Frontmatter, GitBook components, HTML tables, links/URLs, image paths, and technical literals are unchanged. Error Catalog message literals and language-rule tables left intact. SUMMARY.md (navigation) not touched.

Generated with Claude Code

Apply the Snyk documentation writing-style rules across the scan-fix-and-prevent
section (239 files updated). Excludes the Snyk API & Web pages (snyk-api-web/),
which were styled separately on the api-and-web-style-review branch.

Consistent changes:
- Passive to active voice; present tense over future "will"
- Capability phrasing ("allows/enables you to" -> "lets you"); "is able to" -> "can"
- once -> after; in order to -> to; via -> through/using; make sure -> ensure;
  remove filler (just, simply, easily, currently)
- Bold UI labels without element-type nouns; dropdown; check box "select/clear"
- Spell out one-nine; commas in thousands; Projects/Organizations/Groups casing
- Remove brand possessives, AI buzzwords, "(s)" plurals; fix obvious typos

Frontmatter, GitBook components, HTML tables, links, and technical literals unchanged.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@TashaTBaker TashaTBaker requested a review from a team as a code owner June 18, 2026 10:54
@snyk-io

snyk-io Bot commented Jun 18, 2026

Copy link
Copy Markdown

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

Status Scan Engine 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.

* **Projects Monitored**: Number of Snyk Projects continuously monitored for open-source vulnerabilities and license issues after using the `snyk monitor` CLI command.
* **Agentic Scans**: Number of Snyk Studio scans for the selected timeframe.
* **Developers running agentic scans: S**nyk Studio adoption rate.
* **Developers running agentic scans:** Snyk Studio adoption rate.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
* **Developers running agentic scans:** Snyk Studio adoption rate.
* **Developers running agentic scans**: Snyk Studio adoption rate.

Snyk 2.0 introduces UI enhancements to the platform navigation and is available in Early Access. This is being rolled out gradually, so not all users see the new navigation at the same time.

If you are an existing user, you can switch between the new and classic navigation at any time using the toggle in your user profile menu. For more information, visit [Snyk 2.0 platform improvements](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/snyk-2.0-platform-improvements).
If you are an existing user, you can switch between the new and classic navigation at any time using the toggle in your user profile menu. For more information, see [Snyk 2.0 platform improvements](https://app.gitbook.com/s/L7HyJj9FsK1W4pNt8Gzl/snyk-2.0-platform-improvements).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Isn't visit correct?


{% hint style="warning" %}
Google Container Registry (GCR) has been [officially deprecated](https://cloud.google.com/container-registry/docs/release-notes#May_15_2023) by Google and is no longer supported. Google has replaced GCR with the new Google Artifact Registry (GAR). All Snyk customers should **immediately** migrate to the [Snyk GAR integration](integrate-with-google-artifact-registry-gar.md). \
Google Container Registry (GCR) has been [officially deprecated](https://cloud.google.com/container-registry/docs/release-notes#May_15_2023) by Google and is no longer supported. Google has replaced GCR with the new Google Artifact Registry (GAR). All Snyk customers must **immediately** migrate to the [Snyk GAR integration](integrate-with-google-artifact-registry-gar.md). \

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

It's been 3 years, should we remove this page and redirect to the GAR page?

Sometimes there is no direct upgrade that can address the vulnerability, or an upgrade is not possible due to functional reasons, for example, the upgrade is a major breaking change.

In such cases, Snyk can help you [protect your code with patches](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/snyk-cli/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-protect-package). This option will make minimal modifications to your locally installed`node_modules` files to fix the vulnerability. It will also update the policy to patch this issue when you use [@snyk/protect](https://github.com/snyk/cli/tree/master/packages/snyk-protect).
In such cases, Snyk can help you [protect your code with patches](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/snyk-cli/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-protect-package). This option makes minimal modifications to your locally installed`node_modules` files to fix the vulnerability. It also updates the policy to patch this issue when you use [@snyk/protect](https://github.com/snyk/cli/tree/master/packages/snyk-protect).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
In such cases, Snyk can help you [protect your code with patches](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/snyk-cli/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-protect-package). This option makes minimal modifications to your locally installed`node_modules` files to fix the vulnerability. It also updates the policy to patch this issue when you use [@snyk/protect](https://github.com/snyk/cli/tree/master/packages/snyk-protect).
In such cases, Snyk can help you [protect your code with patches](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/snyk-cli/snyk-cli/scan-and-maintain-projects-using-the-cli/snyk-protect-package). This option makes minimal modifications to your locally installed `node_modules` files to fix the vulnerability. It also updates the policy to patch this issue when you use [@snyk/protect](https://github.com/snyk/cli/tree/master/packages/snyk-protect).

## View compliance issues

Snyk’s [Git-based integrations ](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/integrations/scm-integrations/organization-level-integrations)support license scanning as part of the regular workflow. During scanning, license issues appear as a filterable list in the **Issues** tab.
The [Git-based integrations ](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/integrations/scm-integrations/organization-level-integrations)in Snyk support license scanning as part of the regular workflow. During scanning, license issues appear as a filterable list in the **Issues** tab.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
The [Git-based integrations ](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/integrations/scm-integrations/organization-level-integrations)in Snyk support license scanning as part of the regular workflow. During scanning, license issues appear as a filterable list in the **Issues** tab.
The [Git-based integrations](https://app.gitbook.com/s/IEEjSXQQu36y0vmFV8zf/integrations/scm-integrations/organization-level-integrations) in Snyk support license scanning as part of the regular workflow. During scanning, license issues appear as a filterable list in the **Issues** tab.

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