Skip to content

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

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

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

Conversation

@jth-nw
Copy link
Collaborator

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

No description provided.

@jth-nw jth-nw requested a review from a team as a code owner March 11, 2026 18:34
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 (passive) — Line 13: "The monitoring plan can be configured by the user" uses passive voice. Suggested fix: "Use the monitoring plan to monitor various aspects of the system."
  • Voice (passive) — Line 21: "The configuration can be saved by clicking the Save button" uses passive voice. Suggested fix: "Click Save."
  • Voice (passive) — Line 22: "changes will take effect after the service is restarted" uses passive voice. Suggested fix: "Restart the service to apply changes."
  • Voice (first person) — Line 26: "We believe that this feature is very useful" uses prohibited first person and marketing language. Suggested fix: Remove the sentence or restate factually: "This feature helps administrators monitor systems."
  • Voice (first person) — Line 26: "reach out to our support team" uses first person ("our"). Suggested fix: "contact Netwrix support."
  • Clarity (impersonal) — Line 9: "This document is designed to help users" and "It was written by the team" are impersonal and passive. Suggested fix: Remove the meta-sentence entirely; let the content speak for itself.
  • Clarity (impersonal) — Line 20: "It is recommended that the user should select" is impersonal and uses third person. Suggested fix: "Select the appropriate monitoring template."
  • Clarity (ambiguous pronoun) — Line 30 (NOTE): "The user must have administrative privileges" uses third person inconsistently with the rest of the doc. Suggested fix: "You must have administrative privileges to access this feature."
  • Surface (wordiness) — Line 13: "Basically, you just need to follow the steps below to get started with the configuration process" is wordy. Suggested fix: "Follow the steps below to configure the monitoring plan."
  • Surface (wordiness) — Line 15: "In order to utilize the monitoring plan feature, you should ensure that your system meets the necessary prerequisites and requirements that are needed" contains multiple redundancies ("in order to" → "to"; "utilize" → "use"; "prerequisites and requirements that are needed" → "prerequisites"). Suggested fix: "To use the monitoring plan, ensure your system meets the prerequisites."
  • Surface (wordiness) — Line 19: "First of all, click on the Settings button" — "First of all" is filler; "click on" should be "click". Suggested fix: "Click Settings in the navigation bar."
  • Surface (redundancy) — Line 28: "tested in a non-production environment first before deploying to production" — "first" and "before" are redundant. Suggested fix: "Test all changes in a non-production environment before deploying to production."

Summary

10 Vale issues (see inline comments), 12 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 Vale and editorial issues in test-doc-pr.md: converted passive
voice to active, removed first-person (we/our), rewrote impersonal
constructions, eliminated wordiness, converted NOTE blockquote to
admonition, and fixed heading capitalisation.

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 Vale and editorial issues from the review:
    • Heading: corrected capitalisation ("Plan" → "plan")
    • Removed impersonal meta-sentence ("This document is designed to help users...")
    • Rewrote passive-voice sentences to active voice (3 instances)
    • Removed first-person language ("We believe", "our support team")
    • Fixed impersonal constructions ("It is recommended that the user should...")
    • Removed wordiness ("First of all", "In order to utilize", "click on", redundant "first before")
    • Converted NOTE blockquote to :::note admonition
    • Fixed third-person "The user" → "You" in the note

Vale passes with 0 errors 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