Skip to content

test: verify vale-autofix runs only once after bot-check fix#701

Closed
jth-nw wants to merge 5 commits intodevfrom
test/vale-dale-autofix-single-run
Closed

test: verify vale-autofix runs only once after bot-check fix#701
jth-nw wants to merge 5 commits intodevfrom
test/vale-dale-autofix-single-run

Conversation

@jth-nw
Copy link
Copy Markdown
Collaborator

@jth-nw jth-nw commented Apr 1, 2026

Summary

  • Test file with violations spanning all three autofix phases (script, Claude/Vale, Dale)
  • Verifies that the bot-check fix from added heading anchor links check #695 prevents the re-trigger loop
  • Expected: workflow runs once, fixes what it can, and stops

What to watch

  • Only one Vale Auto-Fix workflow run should complete (not 3+)
  • Phases 1-3 should all execute in that single run

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

Auto-Fix Summary

59 issues fixed, 2 skipped across 1 files

Category Fixes
Contractions 4
Plurals 1
Removed filler 3
Spacing 1
Substitutions 15
AllowsYouTo (rewrite) 1
BoilerplateCrossRef (rewrite) 1
FirstPerson (rewrite) 1
FirstPersonPlural (rewrite) 3
FollowTheStepsTo (rewrite) 1
FormalHedging (rewrite) 3
Idioms (rewrite) 6
ImpersonalFiller (rewrite) 3
NoteThat (rewrite) 2
OnceUsage (rewrite) 1
WeakLinkText (rewrite) 1
WhetherOrNot (rewrite) 1
Dale: exclamatory-sentences 1
Dale: idioms 1
Dale: minimizing-difficulty 1
Dale: misplaced-modifiers 1
Dale: negative-assumptions 1
Dale: passive-voice 3
Dale: positional-references 2
Dale: xy-slop 1
Skipped (needs manual review) Reason

| docs/test-autofix-single-run.md:9 — Dale: negative-assumptions | Standard prerequisite/access-control statement; not a product capability claim |
| docs/test-autofix-single-run.md:15 — Dale: misplaced-modifiers | 'Whether you have completed the initial setup' is ambiguous — could mean 'regardless of whether', changing it would alter intended meaning |

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

Documentation PR Review

Editorial Review

docs/test-autofix-single-run.md

  • Structure — Line 5: The sentence "To log in to your account, ensure you have administrator privileges." is a prerequisite condition, not overview content. Move login and credentials requirements to the Prerequisites section so readers can find them when preparing to use the feature. Suggested fix: Remove from Overview; add "You have administrator privileges and valid credentials." as a bullet in Prerequisites.

  • Structure — Line 15: The Prerequisites section is a run-on paragraph rather than a scannable list. Readers use prerequisites as a checklist — a paragraph format forces them to read the whole block to know what they need. Suggested fix: Reformat as a bulleted list, one prerequisite per item. For example: "- You have completed the initial setup." / "- You have selected your environment from the dropdown menu."

  • Structure — Line 29 (step 3): "The installer lets you deploy across multiple servers." is explanatory content embedded in a numbered procedure. Numbered steps should be user actions, not capability descriptions. Readers following steps sequentially will be confused about what to do here. Suggested fix: Either remove this sentence or rewrite it as an action the user takes, or move it to a note or the Overview.

  • Structure — Line 43: The heading "Setting Up Alerts" is a gerund, which Netwrix standards reserve for concept/overview headings. The content under this heading is procedural (it has instructions and a link). Suggested fix: Change to the imperative form "Set Up Alerts" to match the task-topic convention.

  • Clarity — Line 33: "This is a critical step. Don't skip it." appears after step 4 with no clear referent — it's ambiguous which step is critical and what consequence follows from skipping it. Suggested fix: Attach the warning to the specific step and state the consequence. For example: move it inside step 4 as a note, or write "If you skip this step, the agent will not deploy correctly."

  • Clarity — Line 47: "The administrator completed the configuration before the deployment." uses past tense and third person, which reads as a description of what someone else already did — not an instruction for the reader. This breaks the second-person, present-tense convention for procedures. Suggested fix: Rewrite as a user action: "Complete the configuration before you deploy." or remove it if it duplicates step context.

  • Clarity — Line 49: "This is a comprehensive alerting framework." adds no useful information — "comprehensive" is a marketing qualifier that doesn't tell the reader what the framework does or covers. Suggested fix: Remove the sentence, or replace it with a specific statement about what the alerting framework includes (e.g., "The alerting framework supports email, webhook, and SIEM integrations.").

  • Clarity — Line 53: "This solution isn't a complete fix, but it addresses most common problems." — "this solution" has no referent. The Troubleshooting section has not yet described any solution when this sentence appears. Suggested fix: Either introduce a specific remediation before this sentence, or remove the hedge entirely and describe what the reader should actually do.

  • Clarity — Line 55: "The product uses industry-standard technology to deliver a significant advancement in the security space." is marketing language that provides no actionable information in a Troubleshooting section. Readers here are trying to solve a problem, not evaluate the product. Suggested fix: Remove the sentence entirely.

  • Completeness — Line 11: "See the admin guide for configuration details and available options." references "the admin guide" without a link or a document name the reader can search for. A reader who needs more detail cannot follow this reference. Suggested fix: Add a link or specify the document title and location. For example: "See Admin Guide for configuration details."

  • Completeness — Line 55: "The logs are in the directory shown above." — no directory path appears anywhere in the document above this line. A reader troubleshooting an issue cannot find the logs without this information. Suggested fix: Specify the actual log path, for example: "The logs are in C:\ProgramData\Netwrix\Logs\ (Windows) or /var/log/netwrix/ (Linux)." Adjust paths to match the actual product.


Summary

11 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.

@jth-nw
Copy link
Copy Markdown
Collaborator Author

jth-nw commented Apr 1, 2026

@claude fix all the editorial issues

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

Fix complete:

  • Apply all 11 editorial fixes to docs/test-autofix-single-run.md
  • Commit and push changes

Summary — docs/test-autofix-single-run.md:

  • Structure: Moved credentials requirement from Overview to Prerequisites
  • Structure: Reformatted Prerequisites paragraph as a bulleted list
  • Structure: Removed capability description from step 3; renumbered steps and attached a consequence note to the customization step
  • Structure: Changed heading "Setting Up Alerts" → "Set Up Alerts" (imperative form for task topic)
  • Clarity: Rewrote past-tense admin sentence as a user action: "Complete the configuration before you deploy."
  • Clarity: Removed "This is a comprehensive alerting framework." (no actionable information)
  • Clarity: Removed ambiguous troubleshooting hedge ("This solution isn't a complete fix...")
  • Clarity: Removed marketing sentence about industry-standard technology
  • Completeness: Added link to Admin Guide reference
  • Completeness: Replaced "the directory shown above" with actual log paths for Windows and Linux

- Move credentials prerequisite from Overview to Prerequisites section
- Reformat Prerequisites as a bulleted list
- Remove capability description from step 3; renumber and attach warning note to step 3
- Fix heading "Setting Up Alerts" → "Set Up Alerts" (imperative for task topic)
- Rewrite past-tense admin sentence as user action ("Complete the configuration before you deploy.")
- Remove vague marketing sentence ("This is a comprehensive alerting framework.")
- Remove ambiguous troubleshooting hedge sentence
- Remove marketing sentence about industry-standard technology
- Add link to Admin Guide reference
- Specify actual log paths in Troubleshooting

Co-Authored-By: Claude <noreply@anthropic.com>
@jth-nw jth-nw closed this Apr 1, 2026
@jth-nw jth-nw deleted the test/vale-dale-autofix-single-run branch April 1, 2026 17:47
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