Skip to content

Commit 85da06c

Browse files
committed
Merge branch 'main' into collectioneur/transition-tracker-v2
2 parents 3ef984b + 67b752a commit 85da06c

1,454 files changed

Lines changed: 68158 additions & 17917 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/helpdot-inline-reviewer.md

Lines changed: 16 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -9,52 +9,25 @@ model: inherit
99

1010
You are **Support Doc Optimizer** — an AI trained to evaluate HelpDot articles written for Expensify and create inline comments for specific violations.
1111

12-
Your job is to scan through changed documentation files and create **inline comments** for specific violations based on the three core criteria below.
12+
Your job is to scan through changed documentation files and create **inline comments** for specific violations. **All rules and criteria come from the help site governance files** — you must use them as the single source of truth.
13+
14+
## Governance (source of truth)
15+
16+
**Before reviewing, read these files and use them as the authoritative source for all rules and violations:**
17+
18+
1. **docs/HELPSITE_NAMING_CONVENTIONS.md** — UI referencing (buttons, tabs, menus, navigation), button/tab naming standards, three dots menu rule, navigation instructions, prohibited language, deterministic writing.
19+
2. **docs/HELP_AUTHORING_GUIDELINES.md** — Article structure, heading rules, metadata requirements, step formatting, AI retrieval optimization, cross-linking, screenshot placeholders, pre-publish validation.
20+
3. **docs/TEMPLATE.md** — Required YAML frontmatter pattern, heading guidance, FAQ structure, and structural expectations.
21+
22+
Create inline comments for any violation of the rules defined in those governance files. When in doubt, the governance docs override any other guidance.
1323

1424
**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.
1525

16-
## 1. Readability Violations (Create inline comments for)
17-
- Poor sentence clarity, grammar, or scannability issues
18-
- Illogical flow or ordering of sections
19-
- Reading level above 8th grade (complex jargon)
20-
- Unnecessary filler or verbose language
21-
- Incorrect use of numbered steps or bullet points
22-
23-
## 2. AI Readiness Violations (Create inline comments for)
24-
- 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)
26-
- Non-descriptive headings (e.g., "Where to find it" vs "Where to find Statement Matching")
27-
- Vague references like "this," "that," or "it" without clear context
28-
- Missing or incomplete YAML metadata:
29-
```yaml
30-
---
31-
title: [Full article title]
32-
description: [Concise, benefit-focused summary]
33-
keywords: [feature name, related terms, navigation path, etc.]
34-
internalScope: Audience is [target role]. Covers [main topic]. Does not cover [excluded areas].
35-
---
36-
```
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].`
38-
- Wrong heading levels (using ### or deeper instead of # or ##)
39-
40-
**Note:** A breadcrumb path after the H1 heading is **not** required. Do not flag missing breadcrumbs as a violation.
41-
42-
## 3. Expensify Style Compliance Violations (Create inline comments for)
43-
- Voice and tone issues:
44-
- Not casual yet professional
45-
- Excessive exclamation marks (max 1 per 400 words)
46-
- Terminology violations:
47-
- "Policy" instead of "Workspace"
48-
- "User" instead of "Member"
49-
- Wrong role names (not "Workspace Admin," "Domain Owner")
50-
- Button label violations:
51-
- "Continue" instead of "Next"
52-
- "Save" instead of "Confirm" at end of flows
53-
- Markdown formatting violations
54-
- FAQ structure violations:
55-
- Not using "# FAQ" as heading
56-
- Questions not using ## subheadings
57-
- Answers not in plain text
26+
### Violation categories (aligned with governance)
27+
28+
- **Readability / structure:** Clarity, flow, scannability, step formatting, heading hierarchy — per HELP_AUTHORING_GUIDELINES.md and TEMPLATE.md.
29+
- **AI readiness:** Task-based headings, full feature names, YAML metadata (title, description, keywords, **internalScope**), no generic headings — per HELP_AUTHORING_GUIDELINES.md and TEMPLATE.md. (Breadcrumb paths after H1 are not required; do not flag their absence.)
30+
- **Naming and style:** Exact UI labels, button/tab naming, terminology (e.g. Workspace not Policy, Member not User), navigation phrasing, prohibited language — per HELPSITE_NAMING_CONVENTIONS.md and HELP_AUTHORING_GUIDELINES.md. FAQ must use `# FAQ` and ## for questions per TEMPLATE.md.
5831

5932
## Instructions
6033

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

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,30 @@ model: inherit
99

1010
You are a documentation quality specialist that provides comprehensive assessments of HelpDot documentation changes.
1111

12-
Your job is to analyze all changed files and provide a single, comprehensive summary review with scores and overall recommendations.
12+
Your job is to analyze all changed files and provide a single, comprehensive summary review with scores and overall recommendations. **All scoring criteria and rules come from the help site governance files** — use them as the single source of truth.
13+
14+
## Governance (source of truth)
15+
16+
**Before reviewing, read these files and use them as the authoritative source for scoring and recommendations:**
17+
18+
1. **docs/HELPSITE_NAMING_CONVENTIONS.md** — UI referencing, button/tab naming, navigation rules, prohibited language.
19+
2. **docs/HELP_AUTHORING_GUIDELINES.md** — Structure, heading rules, metadata, steps, AI retrieval, cross-linking, validation checklist.
20+
3. **docs/TEMPLATE.md** — YAML frontmatter, heading guidance, FAQ structure.
1321

1422
**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.
1523

1624
## Scoring Criteria
1725

18-
### 1. Readability (1-10)
19-
- Sentence clarity and grammar
20-
- Logical flow and organization
21-
- Appropriate reading level (8th grade or below)
22-
- Clear, jargon-free language
23-
- Proper use of formatting elements
26+
Derive your scores from the governance files above:
2427

25-
### 2. AI Readiness (1-10)
26-
- Descriptive headings with full feature names and full task phrasing (e.g., "Expense Rule options for Workspace Admins" not "Options")
27-
- Clear context without vague references
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)
29-
- Consistent heading hierarchy (# and ## only)
28+
### 1. Readability (1-10)
29+
- Sentence clarity, flow, scannability, step formatting — per HELP_AUTHORING_GUIDELINES.md and TEMPLATE.md.
3030

31-
**Note:** Breadcrumb paths after H1 are not required; do not penalize for their absence.
31+
### 2. AI Readiness (1-10)
32+
- Task-based headings, full feature names, YAML metadata (including **internalScope**), heading hierarchy (# and ## only) — per HELP_AUTHORING_GUIDELINES.md and TEMPLATE.md. (Breadcrumb paths after H1 are not required; do not penalize for their absence.)
3233

3334
### 3. Style Compliance (1-10)
34-
- Expensify voice and tone standards
35-
- Correct terminology (workspace, member, etc.)
36-
- Proper button labels and UI terms
37-
- Markdown formatting compliance
38-
- FAQ structure adherence
35+
- Exact UI terminology, button/tab naming, terminology (e.g. Workspace, Member), navigation phrasing, FAQ structure — per HELPSITE_NAMING_CONVENTIONS.md and HELP_AUTHORING_GUIDELINES.md.
3936

4037
## Output Format
4138

.claude/commands/review-helpdot-pr.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,21 @@ allowed-tools: Bash(gh pr comment:*),Bash(gh pr diff:*),Bash(gh pr view:*),mcp__
33
description: Review a HelpDot documentation pull request
44
---
55

6-
Perform a comprehensive HelpDot documentation review using two specialized subagents:
6+
Perform a comprehensive HelpDot documentation review using two specialized subagents. Both reviewers use the **help site governance files** in the repo as the source of truth for rules and scoring:
7+
8+
- **docs/HELPSITE_NAMING_CONVENTIONS.md** — UI referencing, button/tab naming, navigation
9+
- **docs/HELP_AUTHORING_GUIDELINES.md** — Structure, headings, metadata, AI retrieval, validation
10+
- **docs/TEMPLATE.md** — YAML frontmatter, heading guidance, FAQ structure
711

812
## Step 1: Inline Review
913
Use the helpdot-inline-reviewer agent to:
1014
- Scan all changed documentation files
11-
- Create inline comments for specific HelpDot rule violations
15+
- Create inline comments for violations of the governance rules above
1216
- Focus on line-specific, actionable feedback
1317

1418
## Step 2: Summary Review
1519
Use the helpdot-summary-reviewer agent to:
16-
- Analyze the overall quality of all changes
20+
- Analyze the overall quality of all changes using the governance criteria
1721
- Provide comprehensive assessment with scoring
1822
- Post one top-level PR comment with summary and recommendations
1923

.github/workflows/authorChecklist.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,22 @@ on:
99
paths-ignore: ['docs/articles/**/*.md', 'docs/redirects.csv', 'docs/assets/images/**']
1010

1111
jobs:
12+
validate:
13+
uses: ./.github/workflows/contributorValidationGate.yml
14+
with:
15+
PR_NUMBER: ${{ github.event.pull_request.number }}
16+
PR_AUTHOR: ${{ github.event.pull_request.user.login }}
17+
AUTHOR_ASSOCIATION: ${{ github.event.pull_request.author_association }}
18+
1219
# Note: PHP specifically looks for the name of this job, "checklist", so if the name of the job is changed,
1320
# then you also need to go into PHP and update the name of this job in the GH_JOB_NAME_CHECKLIST constant
1421
checklist:
22+
needs: [validate]
1523
runs-on: blacksmith-2vcpu-ubuntu-2404
16-
if: github.actor != 'OSBotify' && github.actor != 'imgbot[bot]'
24+
if: |
25+
needs.validate.outputs.IS_AUTHORIZED == 'true'
26+
&& github.actor != 'OSBotify'
27+
&& github.actor != 'imgbot[bot]'
1728
steps:
1829
- name: Checkout
1930
# v4

.github/workflows/cherryPick.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,79 @@ jobs:
211211
git push origin ${{ inputs.TARGET }}
212212
fi
213213
214+
- name: Find deploy workflow run
215+
# Also runs for version-bump-only CPs where HAS_CONFLICTS is unset
216+
if: ${{ steps.cherryPick.outputs.HAS_CONFLICTS != 'true' }}
217+
id: findDeployRun
218+
run: |
219+
PUSH_SHA=$(git rev-parse HEAD)
220+
echo "Push SHA: $PUSH_SHA"
221+
222+
DEPLOY_RUN_URL=""
223+
for i in 1 2 3 4 5 6; do
224+
echo "Polling for deploy run (attempt $i)..."
225+
sleep 10
226+
DEPLOY_RUN_URL=$(gh api \
227+
"repos/${{ github.repository }}/actions/workflows/deploy.yml/runs?head_sha=$PUSH_SHA&per_page=1" \
228+
--jq '.workflow_runs[0].html_url // empty' 2>/dev/null || true)
229+
if [ -n "$DEPLOY_RUN_URL" ]; then
230+
echo "Found deploy run: $DEPLOY_RUN_URL"
231+
break
232+
fi
233+
done
234+
235+
FALLBACK_URL="https://github.com/${{ github.repository }}/actions/workflows/deploy.yml"
236+
if [ -z "$DEPLOY_RUN_URL" ]; then
237+
echo "::warning::Could not find deploy workflow run for SHA $PUSH_SHA"
238+
{
239+
echo "DEPLOY_RUN_FOUND=false"
240+
echo "DEPLOY_RUN_URL=$FALLBACK_URL"
241+
echo "DEPLOY_RUN_MESSAGE=⚠️ Could not locate deploy run — check $FALLBACK_URL"
242+
} >> "$GITHUB_OUTPUT"
243+
else
244+
{
245+
echo "DEPLOY_RUN_FOUND=true"
246+
echo "DEPLOY_RUN_URL=$DEPLOY_RUN_URL"
247+
echo "DEPLOY_RUN_MESSAGE=$DEPLOY_RUN_URL"
248+
} >> "$GITHUB_OUTPUT"
249+
fi
250+
env:
251+
GITHUB_TOKEN: ${{ github.token }}
252+
253+
- name: Announce successful CP in #deployer
254+
# Also runs for version-bump-only CPs where HAS_CONFLICTS is unset
255+
if: ${{ steps.cherryPick.outputs.HAS_CONFLICTS != 'true' }}
256+
uses: 8398a7/action-slack@1750b5085f3ec60384090fb7c52965ef822e869e
257+
with:
258+
status: custom
259+
custom_payload: |
260+
{
261+
channel: '#deployer',
262+
attachments: [{
263+
color: 'good',
264+
text: `🍒 Cherry-pick to *${{ inputs.TARGET }}* successful\nPR: ${{ inputs.PULL_REQUEST_URL || '(version bump only)' }}\nDeploy workflow: ${{ steps.findDeployRun.outputs.DEPLOY_RUN_MESSAGE }}`
265+
}]
266+
}
267+
env:
268+
GITHUB_TOKEN: ${{ github.token }}
269+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK }}
270+
271+
- name: Write workflow summary
272+
# Also runs for version-bump-only CPs where HAS_CONFLICTS is unset
273+
if: ${{ steps.cherryPick.outputs.HAS_CONFLICTS != 'true' }}
274+
run: |
275+
{
276+
echo "## Cherry-pick successful"
277+
echo ""
278+
echo "**Target:** \`${{ inputs.TARGET }}\`"
279+
echo "**PR:** ${{ inputs.PULL_REQUEST_URL || 'N/A (version bump only)' }}"
280+
if [[ "${{ steps.findDeployRun.outputs.DEPLOY_RUN_FOUND }}" == "true" ]]; then
281+
echo "**Deploy workflow:** ${{ steps.findDeployRun.outputs.DEPLOY_RUN_URL }}"
282+
else
283+
echo "**Deploy workflow:** :warning: Could not locate deploy run — check [${{ inputs.TARGET }} deploy runs](${{ steps.findDeployRun.outputs.DEPLOY_RUN_URL }})"
284+
fi
285+
} >> "$GITHUB_STEP_SUMMARY"
286+
214287
- name: Create Pull Request to manually finish CP
215288
if: steps.cherryPick.outputs.HAS_CONFLICTS == 'true'
216289
id: createPullRequest

.github/workflows/cla.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@ on:
88
branches: [main]
99

1010
jobs:
11+
validate:
12+
if: ${{ github.event_name == 'pull_request_target' }}
13+
uses: ./.github/workflows/contributorValidationGate.yml
14+
with:
15+
PR_NUMBER: ${{ github.event.pull_request.number }}
16+
PR_AUTHOR: ${{ github.event.pull_request.user.login }}
17+
AUTHOR_ASSOCIATION: ${{ github.event.pull_request.author_association }}
18+
1119
CLA:
20+
needs: [validate]
21+
if: |
22+
always()
23+
&& (github.event_name == 'issue_comment' || needs.validate.outputs.IS_AUTHORIZED == 'true')
1224
uses: Expensify/GitHub-Actions/.github/workflows/cla.yml@main
1325
secrets: inherit

.github/workflows/claude-review.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,19 @@ concurrency:
1313
cancel-in-progress: true
1414

1515
jobs:
16+
validate:
17+
uses: ./.github/workflows/contributorValidationGate.yml
18+
with:
19+
PR_NUMBER: ${{ github.event.pull_request.number }}
20+
PR_AUTHOR: ${{ github.event.pull_request.user.login }}
21+
AUTHOR_ASSOCIATION: ${{ github.event.pull_request.author_association }}
22+
1623
review:
17-
if: github.event.pull_request.draft != true && !contains(github.event.pull_request.title, 'Revert')
24+
needs: [validate]
25+
if: |
26+
needs.validate.outputs.IS_AUTHORIZED == 'true'
27+
&& github.event.pull_request.draft != true
28+
&& !contains(github.event.pull_request.title, 'Revert')
1829
runs-on: blacksmith-2vcpu-ubuntu-2404
1930
env:
2031
PR_NUMBER: ${{ github.event.pull_request.number }}

0 commit comments

Comments
 (0)