Skip to content

test: add intentionally flawed doc for editorial review stress test#661

Open
jth-nw wants to merge 4 commits intodevfrom
test/editorial-review-stress-test
Open

test: add intentionally flawed doc for editorial review stress test#661
jth-nw wants to merge 4 commits intodevfrom
test/editorial-review-stress-test

Conversation

@jth-nw
Copy link
Collaborator

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

No description provided.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@jth-nw jth-nw requested a review from a team as a code owner March 24, 2026 17:20
@github-actions
Copy link
Contributor

Documentation PR Review

Editorial Review

  • Structure — Line 15/21/25: Steps are out of order. "Step 3: Apply the Policy" appears before "Step 1: Create a New Policy" and "Step 2: Configure Policy Settings." Reorder the sections so they read Step 1 → Step 2 → Step 3.

  • Acronym — Line 11: "RBAC" is used without being spelled out on first use. Suggested fix: "role-based access control (RBAC)"

  • Heading/content mismatch — Line 9: The page title is "Managing Session Policies and Configuration," but the first section heading is "Overview of the RBAC System." This creates a disconnect for readers. Suggested fix: Rename the section "Session Policy Overview" or "How Session Policies Work," and focus the content on session policies rather than RBAC generically.

  • Frontmatter description — Line 4: The description field starts with "This document provides information about how..." — this is boilerplate and adds no value for search or readers. Suggested fix: State the purpose directly, e.g., "Configure and manage session policies in Privilege Secure, including duration, idle timeout, recording, and MFA requirements."

  • Impersonal filler phrases — Lines 17, 23, 29, 33, 44, 46, 52, 56, 58, 62, 64, 66: The document uses "It is recommended that," "It should be noted that," "It is possible to," and "It is necessary to ensure" repeatedly as sentence openers. These add no information. Suggested fix: Rewrite each as a direct statement, e.g., "Review the default values before making changes" instead of "It is recommended that the default values are reviewed before any changes are made by the administrator."

Summary

5 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. For example:

  • @claude fix all issues — fix all editorial 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.

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

Auto-Fix Summary

40 issues fixed, 0 skipped across 1 files

Category Fixes
Contractions 1
Substitutions 9
HeadingPunctuation (rewrite) 3
Dale: passive-voice 17
Dale: positional-references 2
Dale: wordiness 8

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

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