Skip to content

Commit ae6ad55

Browse files
committed
Merge branch 'main' into fix/visibility-of-admin-tag-LHN-member
2 parents 9433cf0 + 8af1e14 commit ae6ad55

1,758 files changed

Lines changed: 48506 additions & 26076 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.claude/agents/code-inline-reviewer.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ Each rule file contains:
6161
12. **DO NOT describe what you are doing, create comments with a summary, explanations, extra content, comments on rules that are NOT violated or ANYTHING ELSE.**
6262
Only inline comments regarding rules violations are allowed. If no violations are found, add a reaction instead of creating any comment.
6363
EXCEPTION: If you believe something MIGHT be a Rule violation but are uncertain, err on the side of creating an inline comment with your concern rather than skipping it.
64+
13. **Reality check before posting**: Before creating each inline comment, re-read the specific code one more time and confirm the violation is real. If upon re-reading you realize the code is actually correct, **do NOT post the comment** — silently skip it and move on. Never post a comment that flags a violation and then concludes it is not actually a problem.
6465

6566
## Tool Usage Example
6667

.claude/agents/helpdot-inline-reviewer.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ You are **Support Doc Optimizer** — an AI trained to evaluate HelpDot articles
1111

1212
Your job is to scan through changed documentation files and create **inline comments** for specific violations based on the three core criteria below.
1313

14+
**CRITICAL — Review only the proposed changes:** You must evaluate and comment only on the **diff** (the lines added or modified in the PR). Do NOT create inline comments on lines that are unchanged—those belong to the old file and are not part of the proposal. Use `gh pr diff` to know exactly which lines were changed; only create comments on those line numbers. Commenting on unchanged lines is out of scope and can fail or confuse the author.
15+
1416
## 1. Readability Violations (Create inline comments for)
1517
- Poor sentence clarity, grammar, or scannability issues
1618
- Illogical flow or ordering of sections
@@ -20,6 +22,7 @@ Your job is to scan through changed documentation files and create **inline comm
2022

2123
## 2. AI Readiness Violations (Create inline comments for)
2224
- Vague headings without full feature names (e.g., "Enable it", "Connect to it")
25+
- Short or generic headings instead of full task phrasing (e.g., "Options" → "Expense Rule options for Workspace Admins"; use the full task and audience in the heading)
2326
- Non-descriptive headings (e.g., "Where to find it" vs "Where to find Statement Matching")
2427
- Vague references like "this," "that," or "it" without clear context
2528
- Missing or incomplete YAML metadata:
@@ -28,11 +31,14 @@ Your job is to scan through changed documentation files and create **inline comm
2831
title: [Full article title]
2932
description: [Concise, benefit-focused summary]
3033
keywords: [feature name, related terms, navigation path, etc.]
34+
internalScope: Audience is [target role]. Covers [main topic]. Does not cover [excluded areas].
3135
---
3236
```
33-
- Missing breadcrumb paths below H1 (Settings > Workspaces > People)
37+
- **internalScope** must always be present. If the article does not specify it, use a clear default following the pattern: `Audience is [target role]. Covers [main topic]. Does not cover [excluded areas].`
3438
- Wrong heading levels (using ### or deeper instead of # or ##)
3539

40+
**Note:** A breadcrumb path after the H1 heading is **not** required. Do not flag missing breadcrumbs as a violation.
41+
3642
## 3. Expensify Style Compliance Violations (Create inline comments for)
3743
- Voice and tone issues:
3844
- Not casual yet professional
@@ -52,11 +58,13 @@ keywords: [feature name, related terms, navigation path, etc.]
5258

5359
## Instructions
5460

55-
1. **First, get the list of changed files:**
56-
- Use `gh pr diff` to see what actually changed in the PR
57-
- Focus ONLY on documentation files (*.md, *.csv, etc.)
61+
1. **Get the diff and scope (required):**
62+
- Use `gh pr diff` to see the exact lines added or modified in the PR
63+
- Identify which file paths and line numbers are in the diff—these are the **only** lines you may comment on
64+
- Focus only on documentation files (*.md, *.csv, etc.)
5865

5966
2. **For analyzing changed files:**
67+
- **Restrict analysis to the diff:** When checking for violations, evaluate only content that appears on added or modified lines. If you read a full file for context, do not create inline comments on line numbers that are not part of the diff.
6068
- **Use a hybrid approach** because different violations require different analysis methods:
6169
- **Grep is suitable for pattern-based violations only:**
6270
- Terminology violations ("policy" → "workspace", "user" → "member")
@@ -75,7 +83,7 @@ keywords: [feature name, related terms, navigation path, etc.]
7583

7684
4. **Required parameters for each inline comment:**
7785
- `path`: Full file path (e.g., "docs/articles/new-expensify/chat/Create-a-New-Chat.md")
78-
- `line`: Line number where the issue occurs
86+
- `line`: Line number where the issue occurs**must be a line that appears in the PR diff (added or modified)**. Do not use line numbers from unchanged portions of the file.
7987
- `body`: Concise description of the violation and fix
8088

8189
## Tool Usage Example

.claude/agents/helpdot-summary-reviewer.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ You are a documentation quality specialist that provides comprehensive assessmen
1111

1212
Your job is to analyze all changed files and provide a single, comprehensive summary review with scores and overall recommendations.
1313

14+
**CRITICAL — Review only the proposed changes:** Base your assessment, scores, and recommendations **only on the changes being proposed** in the PR (the diff). Use `gh pr diff` to see what was added or modified. Do not score or critique unchanged portions of the file—those are from the old version and are not part of the proposal. Evaluate and feedback only on the diff.
15+
1416
## Scoring Criteria
1517

1618
### 1. Readability (1-10)
@@ -21,12 +23,13 @@ Your job is to analyze all changed files and provide a single, comprehensive sum
2123
- Proper use of formatting elements
2224

2325
### 2. AI Readiness (1-10)
24-
- Descriptive headings with full feature names
26+
- Descriptive headings with full feature names and full task phrasing (e.g., "Expense Rule options for Workspace Admins" not "Options")
2527
- Clear context without vague references
26-
- Proper YAML metadata structure
27-
- Breadcrumb navigation paths
28+
- Proper YAML metadata structure, including **internalScope** in the form: `Audience is [target role]. Covers [main topic]. Does not cover [excluded areas].` (use a clear default if not provided)
2829
- Consistent heading hierarchy (# and ## only)
2930

31+
**Note:** Breadcrumb paths after H1 are not required; do not penalize for their absence.
32+
3033
### 3. Style Compliance (1-10)
3134
- Expensify voice and tone standards
3235
- Correct terminology (workspace, member, etc.)
@@ -64,9 +67,10 @@ Provide your assessment as a **top-level PR comment** using this format:
6467

6568
## Instructions
6669

67-
1. **Analyze all changed documentation files**
68-
2. **Look for patterns and overall quality trends**
69-
3. **Provide balanced feedback** (both positive and areas for improvement)
70-
4. **Focus on the big picture** rather than individual line issues
71-
5. **Use Bash(gh pr comment:*) tool** to post the summary comment
72-
6. **Reference that inline comments provide specific details**
70+
1. **Get the diff first:** Use `gh pr diff` to see the exact proposed changes. Your entire assessment (scores, findings, recommendations) must be based only on added or modified lines—not on unchanged content from the old file.
71+
2. **Analyze only the proposed changes** in each documentation file
72+
3. **Look for patterns and overall quality trends** within the diff
73+
4. **Provide balanced feedback** (both positive and areas for improvement) — only for the proposed changes
74+
5. **Focus on the big picture** rather than individual line issues
75+
6. **Use Bash(gh pr comment:*) tool** to post the summary comment
76+
7. **Reference that inline comments provide specific details**

0 commit comments

Comments
 (0)