Skip to content

test: add doc with intentional violations for debug run#482

Open
jth-nw wants to merge 2 commits intodevfrom
test/doc-pr-debug-11
Open

test: add doc with intentional violations for debug run#482
jth-nw wants to merge 2 commits intodevfrom
test/doc-pr-debug-11

Conversation

@jth-nw
Copy link
Collaborator

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

No description provided.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@jth-nw jth-nw requested a review from a team as a code owner March 11, 2026 18:17
Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Vale found 10 issue(s). See inline comments below.

@github-actions
Copy link
Contributor

Documentation PR Review

Editorial Review

  • Voice — Line 3: Passive voice and first person. "This document is designed to help users... It was written by the team to provide assistance." Drop the meta intro entirely, or rewrite as: "This topic explains how to configure a monitoring plan."
  • Clarity — Line 7: "Basically" is colloquial and should be removed. "Simply" is a minimizer that implies the task is easy. Suggested fix: "Follow the steps below to configure the monitoring plan."
  • Wordiness — Line 9: "In order to utilize" → "To use"; "necessary prerequisites and requirements that are needed" is triply redundant. Suggested fix: "To use the monitoring plan feature, ensure your system meets the prerequisites."
  • Clarity — Line 13: "First of all" is filler in a numbered list. Suggested fix: "Click **Settings** in the navigation bar."
  • Voice — Line 14: Passive voice and impersonal construction. "It is recommended that the user should select..." Suggested fix: "Select the appropriate monitoring template."
  • Voice — Line 15: Passive voice. "The configuration can be saved by clicking the Save button." Suggested fix: "Click **Save**."
  • Voice — Line 16: "Please be advised that" is a bureaucratic filler phrase; the rest of the sentence is also passive. Suggested fix: "Changes take effect after you restart the service."
  • Voice — Line 20: First person ("We believe"). No first person is allowed in Netwrix documentation. Suggested fix: "This feature helps administrators monitor their systems."
  • Wordiness — Line 22: "It is important to note that" is filler; "first before" is redundant. Suggested fix: "Test all changes in a non-production environment before deploying to production."
  • Clarity — Line 24: Switches to third person ("the user") mid-document after using second person elsewhere. Suggested fix: "You must have administrative privileges to access this feature."

Summary

10 Vale issues (see inline comments), 10 editorial suggestions across 1 file.


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

  • @claude fix all issues — fix all Vale and editorial issues
  • @claude fix only the Vale issues — fix just the linting problems
  • @claude help improve the flow of this document — get writing assistance

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

@jth-nw
Copy link
Collaborator Author

jth-nw commented Mar 11, 2026

@claude fix all issues

Fixed all 10 editorial and Vale issues: rewrote passive voice to active,
removed first person, eliminated filler phrases and redundancy, converted
NOTE blockquote to admonition, and fixed heading casing.

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

Fixes applied:

  • docs/accessanalyzer/12.0/admin/monitoringplan/test-doc-pr.md: Fixed all 10 editorial and Vale issues:
    • Rewrote the meta intro as a direct topic statement
    • Fixed heading casing ("monitoring Plan" → "Monitoring Plan")
    • Removed colloquial filler ("Basically", "First of all", "Please be advised", "It is important to note that")
    • Removed minimizers ("simply")
    • Rewrote all passive voice to active voice
    • Rewrote all impersonal constructions to use second person ("you")
    • Removed all first person ("We believe", "our support team")
    • Eliminated redundancy ("necessary prerequisites and requirements that are needed", "first before")
    • Converted the NOTE blockquote to a proper admonition block
    • Tightened all procedure steps to lead with the action

Vale passes with 0 errors, 0 warnings on the edited file.

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.

1 participant