Merge pull request #387 from netwrix/dev

reformat style guide, updated some rules, updated linter workflow

Author: jth-nw

.github/workflows/claude-documentation-reviewer.yml

@@ -258,36 +258,53 @@ jobs:
               return valid
 
           def normalize_review_body(body):
-              """Normalize issue formatting to single-line bullet points."""
+              """Normalize issue formatting to single-line **Line N:** entries."""
               src = body.split('\n')
               result = []
               i = 0
               while i < len(src):
                   line = src[i]
 
-                  # Convert heading format: ### Line N: ... → - Line N: ...
-                  m = re.match(r'^#{1,6}\s+(Line \d+:.+)$', line)
+                  # Convert heading format: ### Line N: ... → **Line N:** ...
+                  m = re.match(r'^#{1,6}\s+(Line \d+):(.+)$', line)
                   if m:
-                      result.append(f'- {m.group(1)}')
+                      result.append(f'**{m.group(1)}:**{m.group(2)}')
                       i += 1
                       continue
 
-                  # Convert bold format: **Line N: title** + sub-bullets → - Line N: single line
+                  # Convert bold-closed format: **Line N: title** + sub-bullets → **Line N:** title. parts.
                   m = re.match(r'^\*\*(Line \d+:.*?)\*\*\s*$', line)
                   if m:
                       title = m.group(1).rstrip('.')
                       i += 1
                       parts = []
                       while i < len(src) and re.match(r'^\s*[-*]\s+', src[i]):
                           sub = re.sub(r'^\s*[-*]\s+', '', src[i])
-                          sub = re.sub(r'^(Issue|Fix|Description|Suggested change):\s*', '', sub, flags=re.IGNORECASE)
+                          sub = re.sub(r'^(Issue|Fix|Description|Suggested change|Current):\s*', '', sub, flags=re.IGNORECASE)
                           if sub.strip():
                               parts.append(sub.strip().rstrip('.'))
                           i += 1
-                      combined = f'- {title}. {". ".join(parts)}.' if parts else f'- {title}.'
+                      combined = f'**{title}. {". ".join(parts)}.**' if parts else f'**{title}.**'
                       result.append(combined)
                       continue
 
+                  # Collapse numbered list items with sub-bullets (e.g. 1. **Issue title**: desc\n  - Current: ...\n  - Fix: ...)
+                  m = re.match(r'^\d+\.\s+\*\*(.+?)\*\*:?\s*(.*)', line)
+                  if m:
+                      title = m.group(1).rstrip('.')
+                      desc = m.group(2).strip().rstrip('.')
+                      i += 1
+                      parts = [desc] if desc else []
+                      while i < len(src) and re.match(r'^\s+[-*]', src[i]):
+                          sub = re.sub(r'^\s+[-*]\s+', '', src[i])
+                          sub = re.sub(r'^(Issue|Fix|Description|Suggested change|Current|Should):\s*', '', sub, flags=re.IGNORECASE)
+                          if sub.strip():
+                              parts.append(sub.strip().rstrip('.'))
+                          i += 1
+                      desc_text = '. '.join(parts).rstrip('.')
+                      result.append(f'**{title}.** {desc_text}.' if desc_text else f'**{title}.**')
+                      continue
+
                   result.append(line)
                   i += 1
               return '\n'.join(result)

.github/workflows/vale-linter.yml

@@ -7,6 +7,10 @@ on:
       - main
     paths:
       - '**.md'
+      - '!**/system.md'
+      - '!**/CLAUDE.md'
+      - '!**/SKILL.md'
+      - '!**/netwrix_style_guide.md'
 
 jobs:
   vale:

CLAUDE.md

@@ -138,9 +138,8 @@ Vale handles pattern-based violations automatically — run it and fix everythin
 
 **Voice and structure**
 - Active voice and present tense throughout
-- Second person ("you") — address the reader directly
+- Second person ("you") or imperative mood for procedures and instructions — third person ("users") is acceptable in overviews and conceptual descriptions
 - Contractions are encouraged: don't, can't, you'll
-- Keep sentences to one idea per sentence
 - Write for a global audience — avoid metaphors, idioms, and culturally specific references that don't translate
 - Omit "currently", "presently", and "as of this writing" — documentation should read as permanently accurate
 

docs/passwordsecure/9.3/index.md

@@ -6,16 +6,8 @@ sidebar_position: 1
 
 # Why Netwrix Password Secure?
 
-Users depend on passwords in their day-to-day business worldwide. Passwords are used constantly and everywhere,
-and they need to be professionally managed. Passwords should be safe, have at least 12 characters, and include uppercase and lowercase characters as well as special characters. In the best case, a separate access
-password should be used for each account. It should be changed regularly. It is hard enough to meet
-this challenge in private settings. In a large corporate environment, adequately managing passwords without the use of a professional password management tool is difficult.
+Passwords are a constant part of daily business life worldwide, and they need to be professionally managed. A secure password should have at least 12 characters and include a mix of uppercase and lowercase letters and special characters — ideally unique to each account and changed regularly. Meeting these requirements is challenging enough for individual users, but in a large corporate environment, managing passwords without a dedicated tool isn't feasible.
 
 ## Scalability
 
-The scalability of Netwrix Password Secure (NPS) makes it suitable for use in SMEs, large
-companies, and global corporations. The flexibility required for this task is the driving factor
-behind the development to meet the ever-changing requirements of modern and safety-conscious
-companies. NPS is a software solution for companies that want to effectively manage
-security-relevant data such as passwords, documents, or certificates at a very high encryption
-level.
+Netwrix Password Secure (NPS) scales from SMEs to global corporations, adapting to the ever-changing requirements of modern, security-conscious organizations. It's a software solution designed to help companies effectively manage security-relevant data — including passwords, documents, and certificates — at a very high encryption level.