demo-linter-violations

[jth-nw]

No description provided.

[github-actions]

Vale found 31 issue(s). See inline comments below. Full summary in the PR comment.

[github-actions]

Vale Linting

Vale found 31 issue(s) across the changed files.

docs/demo-linter-violations.md

Line	Rule	Message
1	Netwrix.SetupUsage	Use 'to set up' — 'setup' is a noun or adjective. The verb form is 'set up' (two words).
1	Netwrix.HeadingPunctuation	Don't use punctuation in headings (':'). Rewrite the heading to remove it.
3	Netwrix.OnceUsage	Avoid 'Once you' for temporal sequence. Use 'After' (for sequential steps) or 'When' (for conditions or events).
3	Netwrix.Please	Avoid 'please' in instructions. Be direct.
3	Netwrix.FirstPersonPlural	Avoid first person plural 'We'. Rewrite without 'we', 'our', 'us', or 'ours'.
3	Netwrix.FirstPerson	Avoid first person singular 'I'. Rewrite without 'I', 'me', 'my', 'mine', or contractions of 'I'.
3	Netwrix.Contractions	Use the contraction 'isn't' instead of the formal form.
3	Netwrix.InOrderTo	Use 'to' instead of 'in order to'.
3	Netwrix.LoginVerb	Use 'log in to' — 'login' as a verb should be two words.
3	Netwrix.MakeSure	Use 'ensure' instead of 'make sure'.
7	Netwrix.AllowsYouTo	Avoid 'allows you to'. Rewrite with a direct imperative or active construction, e.g. 'Use X to ...' or 'With X, you can ...'.
7	Netwrix.Contractions	Use the contraction 'isn't' instead of the formal form.
7	Netwrix.ProvidesAbilityTo	Use 'lets you' instead of 'provides the ability to'.
7	Netwrix.Utilize	Use 'uses' — avoid 'utilize' and its variants.
9	Netwrix.WishTo	Use 'want to' instead of 'wish to', or rewrite as a direct imperative.
9	Netwrix.ClickOn	Use 'click' — omit 'on' after click verbs.
9	Netwrix.OnceUsage	Avoid 'Once the' for temporal sequence. Use 'After' (for sequential steps) or 'When' (for conditions or events).
9	Netwrix.Dropdown	Use 'dropdown' (one word). Avoid 'drop-down' and 'drop down'.
9	Netwrix.NoteThat	Avoid 'Note that'. Use a proper admonition block (Note, Warning, or Tip) for supplementary information.
13	Netwrix.SetupUsage	Use 'to set up' — 'setup' is a noun or adjective. The verb form is 'set up' (two words).
15	Netwrix.ClickOn	Use 'Click' — omit 'on' after click verbs.
16	Netwrix.Repetition	Repeated word 'that' detected.
17	Netwrix.Plurals	Avoid parenthetical plurals 'path(s)'. Use the plural form, or rephrase with 'one or more'.
20	Netwrix.WeakLinkText	Avoid generic link text 'click here'. Write descriptive link text that describes the destination or action.
20	Netwrix.BoilerplateCrossRef	Avoid 'For more information'. Write specific cross-reference text that describes what the reader will find.
22	Netwrix.Aforementioned	Avoid 'aforementioned'. Refer to the subject directly or use 'described earlier'.
22	Netwrix.MakeSure	Use 'ensure' instead of 'make sure'.
22	Netwrix.Plurals	Avoid parenthetical plurals 'item(s)'. Use the plural form, or rephrase with 'one or more'.
24	Netwrix.TemporalHedges	Avoid 'Currently'. Documentation should describe the current state without temporal qualifiers.
24	Netwrix.Spacing	Use a single space after sentence-ending punctuation, not two.
24	Netwrix.FirstPersonPlural	Avoid first person plural 'we'. Rewrite without 'we', 'our', 'us', or 'ours'.

---

Fix these issues locally with vale <file> and push again, or comment @claude followed by your instructions (e.g., @claude fix only the Vale issues).

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

[github-actions]

Dale found 3 issue(s). See inline comments below.

[github-actions]

Documentation PR Review

Editorial Review

• Surface — Line 3: "In order to get started" is wordy. Suggested fix: "To get started"
• Surface — Line 7: Exclamation mark ("…complete auditing solution!") is inappropriate in technical documentation. Suggested fix: Replace ! with .
• Clarity — Line 16: Duplicate word — "the monitoring plan that that you want to configure." Suggested fix: Remove the second "that"
• Surface — Lines 17, 22: (s) constructions (path(s), item(s)) are awkward in prose. Suggested fix: Use "one or more target paths" and "the items" (or rewrite to a plural form)
• Surface — Line 22: e.g. and i.e. abbreviations should be avoided in Netwrix docs. Suggested fix: Replace with "for example" and "that is" respectively, or restructure the sentence
• Clarity — Line 22: "As mentioned above, the aforementioned settings are important" is circular and vague — it does not identify which settings. Suggested fix: Name the specific settings or remove the sentence
• Clarity — Line 24: References "the below table" but no table exists in the document. Suggested fix: Remove the reference or add the missing table

Summary

3 Dale issues (see inline comments), 7 editorial suggestions across 1 file.

---

What to do next:
Comment @claude on this PR followed by your instructions. For example:

• @claude fix all issues
• @claude fix only the Dale issues
• @claude reorganize the prerequisites section
• @claude help improve the flow of this document

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

[jth-nw]

@claude change the intro

[github-actions]

Fix complete:

• Rewrite intro (heading + opening paragraph) in docs/demo-linter-violations.md
• Verify changes
• Commit and push

Summary:

• docs/demo-linter-violations.md: Rewrote the H1 heading (fixed 'Setup' → 'Set Up', removed trailing colon) and the opening paragraph (removed first-person voice, 'please', 'In order to', 'make sure'; replaced 'login' with 'log in' and 'Once' with 'After'; simplified to two direct sentences).

[jth-nw]

@claude why did you rewrite the intro this way?

[github-actions]

Here's a breakdown of each change made to the intro:

Heading: # How to Setup Your First Scan: → # How to Set Up Your First Scan

• SetupUsage: "setup" used as a verb should be two words — "set up". "Setup" (one word) is only correct as a noun or adjective (e.g., "the setup wizard").
• HeadingPunctuation: Netwrix style prohibits punctuation in headings. The trailing colon was removed.

Opening paragraph rewrite

The original was:

Once you have installed the product, please follow the steps below to configure your first scan. We are going to walk you through the entire process. I think you will find it is not hard at all. In order to get started, you will need to login to the console and make sure your credentials are configured.

Each change:

• OnceUsage: "Once you have installed" → "After installing" — use "After" for sequential steps, not "Once".
• Please: Removed "please" — Netwrix style requires direct imperatives in instructions.
• FirstPersonPlural + FirstPerson: Removed "We are going to walk you through..." and "I think you will find..." — these sentences used first-person voice ("We", "I"), which the style guide prohibits. They also added no technical information, so they were dropped entirely rather than rewritten.
• InOrderTo: "In order to get started" → "To get started" — "in order to" is always replaceable with just "to".
• LoginVerb: "login to the console" → "log in to the console" — "log in" as a verb is two words; "login" is a noun/adjective only.
• MakeSure: "make sure your credentials are configured" → "ensure your credentials are configured" — Netwrix style prefers "ensure".
• Contractions: The phrase "it is not hard at all" was in the sentence that was removed (along with the first-person voice), so this was resolved by deletion rather than substitution.

The result keeps every piece of actionable information from the original paragraph while removing the style violations.

[jth-nw]

@claude fix all issues

[github-actions]

Fix complete:

• Fix Vale issues in docs/demo-linter-violations.md (21 fixed)
• Fix Dale issues in docs/demo-linter-violations.md (3 fixed)
• Apply editorial suggestions
• Verify changes
• Commit and push

Summary — docs/demo-linter-violations.md:

• Getting Started paragraph: Rewrote to fix AllowsYouTo, Contractions, ProvidesAbilityTo, Utilize, Dale minimizing-difficulty adverb ("easily"), Dale xy-slop pattern, and exclamation mark
• Paragraph 2: Fixed WishTo, ClickOn, OnceUsage, Dropdown; replaced "Note that" with an admonition block
• Section intro: Fixed SetupUsage (setup → set up)
• Steps 1–6: Fixed ClickOn, duplicate "that that", rewrote passive-voice steps 3–5 to active, fixed Plurals (path(s)), replaced boilerplate/weak link text
• Closing paragraph: Removed circular "aforementioned" sentence, replaced "Make sure" with "Ensure", fixed Plurals (item(s)), replaced e.g./i.e. with full phrases
• Final sentence: Removed Currently temporal hedge, fixed double space, replaced first-person "we plan" with passive construction, removed reference to non-existent table