Skip to content

docs: fix #668 — netscript flow#669

Closed
jth-nw wants to merge 3 commits intodevfrom
fix/issue-668-netscript-flow
Closed

docs: fix #668 — netscript flow#669
jth-nw wants to merge 3 commits intodevfrom
fix/issue-668-netscript-flow

Conversation

@jth-nw
Copy link
Collaborator

@jth-nw jth-nw commented Mar 25, 2026

Closes #668

What changed

fix/issue-668-netscript-flow

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions
Copy link
Contributor

Documentation PR Review

Editorial Review

docs/threatprevention/8.0/admin/policies/configuration/actions/netscript.md

  • Clarity — Line 33: **Script language** is formatted as a UI label (bolded, em dash format), but "Script language" doesn't appear to be an actual label in the interface — the UI likely just shows two radio buttons. A reader scanning the interface for a "Script language" label won't find one. Suggested fix: use descriptive prose instead — "Select the radio button for the script language your script uses:" without the bold label format, or confirm the UI shows this label and use its exact text.

  • Clarity — Line 43: "starter scripts you can modify" is informal. Suggested fix: "default scripts" (consistent with the Reset to Default Script option described later) — "see Default Visual Basic Script and Default C# Script for the default scripts you can build from."

  • Clarity — Line 46: "Back on the Add Action window" — "back on" is informal and implies navigation that doesn't quite apply (the editor opened as a window, not a page transition). Suggested fix: "On the Add Action window, verify your script in the Script Preview section."

  • Structure — Lines 72–75 and 84–88: The Encrypt bullet and the :::warning admonition that follows cover identical ground — both explain that only literal strings should be encrypted, that quote marks should not be included, and that encrypting functions causes failure. The warning adds no new information over the bullet. This duplication creates noise and may make readers uncertain which source to trust. Suggested fix: trim the Encrypt bullet to a single-sentence description of what the option does, and let the warning carry the usage rules — or remove the warning and keep the full explanation in the bullet.

  • Clarity — Line 81: [idiom] "keep this difference in mind when testing" is an idiom. Suggested fix: "account for this difference when testing" or "test accordingly."

Summary

5 editorial suggestions across 1 file. Vale and Dale issues are auto-fixed separately.


What to do next:

Comment @claude on this PR followed by your instructions to get help:

  • @claude fix all issues — fix all editorial issues
  • @claude help improve the flow of this document — get writing assistance
  • @claude explain the voice issues — understand why something was flagged

You can ask Claude anything about the review or about Netwrix writing standards.

Automated fixes are only available for branches in this repository, not forks.

@github-actions
Copy link
Contributor

Auto-Fix Summary

4 issues fixed, 3 skipped across 1 files

Category Fixes
FollowTheStepsTo (rewrite) 1
Dale: passive-voice 3
Skipped (needs manual review) Reason
docs/threatprevention/8.0/admin/policies/configuration/actions/netscript.md:7 — Netwrix.HeadingPunctuation Period is part of the '.NET' product name, not heading punctuation
docs/threatprevention/8.0/admin/policies/configuration/actions/netscript.md:13 — Netwrix.HeadingPunctuation Period is part of the '.NET' product name, not heading punctuation
docs/threatprevention/8.0/admin/policies/configuration/actions/netscript.md:40 — Netwrix.OxfordComma 'create or paste' is a two-item pair, not a series of three or more items; Oxford comma does not apply

Ask @claude on this PR if you'd like an explanation of any fix.

@jth-nw jth-nw closed this Mar 26, 2026
@jth-nw jth-nw deleted the fix/issue-668-netscript-flow branch March 26, 2026 15:54
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.

Fix: The .NET script documentation needs better flow

1 participant