docs: writing-style review — all sections (integration)#1371
Draft
TashaTBaker wants to merge 16 commits into
Draft
docs: writing-style review — all sections (integration)#1371TashaTBaker wants to merge 16 commits into
TashaTBaker wants to merge 16 commits into
Conversation
Apply the Snyk documentation writing-style rules across the discover-snyk
section (95 files updated).
Consistent changes:
- Passive to active voice, naming the actor; present tense over future "will"
- Capability phrasing ("allows/enables you to" -> "lets you"/"you can")
- Word choice: via -> through/using; in order to -> to; prior to -> before;
once -> after; e.g./i.e./etc. -> for example/that is/and so on; & -> and
- Remove brand possessives, AI buzzwords, and filler (just, simply, easily)
- Sentence-case headings; bold UI labels; Projects/Organizations/Groups casing
- Fix copy-paste provider errors and obvious prose typos
Frontmatter, GitBook components, HTML tables, links, and technical literals unchanged.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Apply the Snyk documentation writing-style rules across the
platform-administration section (114 files updated).
Consistent changes:
- Passive to active voice; present tense over future "will"
- Capability phrasing ("allows/enables you to" -> "lets you"); "is able to" -> "can"
- Weaken-modal trimming (may -> can/might where appropriate)
- once -> after; in order to -> to; go to -> navigate to; remove filler (simply, easily)
- Bold UI labels without element-type nouns; Groups/Organizations/Projects casing
- Remove "(s)" plurals; fix obvious typos and provider/casing slips
Frontmatter, GitBook components, HTML tables, links, and technical literals unchanged.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Apply the Snyk documentation writing-style rules across the developer-tools
section (297 files updated).
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;
go to -> navigate to; remove filler (just, simply, easily, currently)
- Bold UI labels without element-type nouns; check box "select/clear"
- Casing: Node.js, GitHub, Bitbucket, Azure DevOps, IaC, AI-BOM; Snyk Web UI;
Projects/Organizations/Groups; AI buzzwords removed
- Fix copy-paste/product-name slips and obvious prose typos
Frontmatter, GitBook/OpenAPI components, code, links, and technical literals unchanged.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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>
Empty marker commit so the integration PR (writing-style-review -> main) can be opened as a draft. Child section PRs stack on top of this base. Safe to drop once the first section PR merges into the base. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
Visit replacing see
web is not capitalised
Co-authored-by: mikeromard <146881896+mikeromard@users.noreply.github.com>
docs: apply Snyk writing-style skill to Discover Snyk pages
docs: apply Snyk writing-style skill to Platform administration pages
docs: apply Snyk writing-style skill to Scan, fix, and prevent pages
docs: apply Snyk writing-style skill to Developer tools pages
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Integration PR for the per-section writing-style review. Aggregates the section PRs that target the shared base branch
writing-style-review, then merges the whole set intomain.Draft until the child PRs are reviewed and merged into
writing-style-review. This PR's diff grows section by section as each child lands in the base branch.Child PRs (each →
writing-style-review)snyk-api-web/)Snyk API & Web (
snyk-api-web/) and Agent security ("Evo by Snyk") are out of scope here and handled separately.Generated with Claude Code