vale dale remaining docs - #1419
Conversation
Documentation PR ReviewThis PR is a broad passive-voice cleanup across the Password Policy Enforcer 11.2 set. Most rewrites are solid. The notes below cover added lines where the rewrite changed meaning, left a sentence incomplete, or created a new comprehension problem. Editorial Reviewdocs/passwordpolicyenforcer/11.2/admin/cmdlets/cmdgetppeserverversion.md
docs/passwordpolicyenforcer/11.2/admin/hibpupdater.md
docs/passwordpolicyenforcer/11.2/admin/manage-policies/rules/rules.md
docs/passwordpolicyenforcer/11.2/admin/manage-policies/testpolicy.md
docs/passwordpolicyenforcer/11.2/admin/password-policy-client/configuring_the_password_policy_client.md
docs/passwordpolicyenforcer/11.2/admin/troubleshooting.md
docs/passwordpolicyenforcer/11.2/evaluation/creating-a-password-policy/policy_templates.md
docs/passwordpolicyenforcer/11.2/evaluation/enforcing_multiple_policies.md
docs/passwordpolicyenforcer/11.2/evaluation/evaluation_overview.md
docs/passwordpolicyenforcer/11.2/evaluation/improving_the_password_policy.md
docs/passwordpolicyenforcer/11.2/evaluation/preparing_the_computer.md
docs/passwordpolicyenforcer/11.2/web-overview/editing_html_templates.md
docs/passwordpolicyenforcer/11.2/web-overview/installationweb.md
docs/passwordpolicyenforcer/11.2/web-overview/using_web.md
docs/passwordpolicyenforcer/11.2/web-overview/web_overview.md
No issues found
Summary19 editorial suggestions across 15 files; 16 files clean. The highest-value fixes are the broken sentences at installationweb.md line 55 and using_web.md line 26, the incorrect step cross-reference at preparing_the_computer.md line 45, and the missing heading at troubleshooting.md line 12. Vale and Dale issues are auto-fixed separately. What to do next: Comment
You can ask Claude anything about the review or about Netwrix writing standards.
|
Auto-Fix Summary47 issues fixed, 10 skipped across 31 files
Ask |
scripts/check-anchors.sh stripped underscores when slugifying headings, disagreeing with the github-slugger algorithm Docusaurus actually uses (which keeps underscores). The vale-dale autofix trusted this checker and rewrote anchor links like #customize-analysis-tasks-for-the- box_filemetrics-job to .../boxfilemetrics-job across accessanalyzer 11.6 and 12.0 docs, satisfying the buggy local check but breaking the real Docusaurus build (~140+ broken anchors, causing the build-and- deploy job to fail). Fix the slugify regex to keep underscores, and restore the underscores in every anchor link the autofix stripped. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
scripts/vale-autofix.sh had its own slugify() that diverged from github-slugger (used by Docusaurus): it stripped underscores and collapsed/trimmed hyphens, neither of which github-slugger does. This is the same class of bug just fixed in scripts/check-anchors.sh, and it lives in update_heading_anchors(), the function that auto-rewrites anchor links in vale-autofix.yml's "Fix heading anchors" step whenever a heading is renamed — so a future underscore-containing heading rename would silently compute the wrong new anchor and reproduce this PR's original failure. Also corrects two now-incorrect expectations in test-slugify.sh that had encoded the old (wrong) hyphen-collapsing behavior. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ests _word_overlap_score() in vale-autofix.sh counted empty array elements (produced by uncollapsed hyphen runs after the earlier slugify fix) in its maxlen denominator, deflating scores enough to push real heading renames below the match threshold — silently skipping an anchor repair that used to work. Also extracts the duplicated slugify() (previously hand-synced between vale-autofix.sh and check-anchors.sh, and the source of two rounds of the same underscore bug) into a single scripts/lib/slugify.sh both scripts source. test-slugify.sh now tests that shared implementation directly instead of only vale-autofix.sh's copy. Wires scripts/test-slugify.sh and scripts/test-anchor-update.sh into CI (new `npm run test:scripts`, run as a step in vale-autofix.yml) so regressions in either script are caught automatically instead of only by manual review. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
No description provided.