[NO QA] Strengthen help site governance rules for headings#85271
[NO QA] Strengthen help site governance rules for headings#85271VictoriaExpensify merged 2 commits intomainfrom
Conversation
…based requirements Clarifies ambiguous heading rules to prevent multiple # headings and non-task-based section titles in HelpDot articles. Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
|
A preview of your ExpensifyHelp changes have been deployed to https://a75b2478.helpdot.pages.dev ⚡️ Updated articles: |
|
@QichenZhu Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
|
@bernhardoj Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button] |
HelpDot Documentation ReviewOverall AssessmentThis PR tightens the HelpDot governance rules around heading structure and task-based heading requirements. The changes are well-motivated -- replacing ambiguous "one primary # heading" language with "Exactly one # heading" and expanding the forbidden headings list to explicitly ban noun-only, topic-only, and platform-only headings. The additions are clear, actionable, and directly address real drift scenarios (e.g., using "iPhone" or "Transaction decline notifications" as headings). The before/after examples are particularly strong and will help authors self-correct. Scores Summary
Key FindingsStrengths
Issues to Address
Recommendations
Files Reviewed
This review assessed only the proposed changes in the diff, not unchanged portions of the files. |
|
test connection |
Inline Review: Governance Rule UpdatesI reviewed the diff for PR #85271. Below are the findings organized by file and line number. Since inline comment creation requires additional permissions, I am posting all findings as a single PR comment with file/line references. docs/HELP_AUTHORING_GUIDELINES.mdLine 44 -- Internal consistency gap (question word list vs. TEMPLATE.md) The new requirement says headings must "Start with an action verb or question word (How, What, Where, Who, Why, When)." However, the official
Under the new rule as written, these template-sanctioned FAQ headings would be flagged as violations. Consider either: Line 245 -- Same consistency gap in Pre-Publish Validation Checklist The checklist item "Every ## heading starts with an action verb or question word (How, What, Where, Who, Why, When)" mirrors the Section 2 rule and inherits the same conflict with TEMPLATE.md FAQ headings. This should be updated to match whatever resolution is chosen for line 44. Line 59 -- Missing feature name in corrected example The corrected heading Line 60 -- Missing feature name in corrected example
Line 61 -- Missing feature name in corrected example
docs/HELPSITE_NAMING_CONVENTIONS.mdLine 12 -- Scope tension with Purpose section Lines 9-11 of this file state: "This document governs UI language conventions. It does not define article structure or Markdown formatting rules." However, the new note on line 12 introduces an article-structure rule (task-based heading requirements) into a document that explicitly disclaims structural guidance. Consider either: Summary
|
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 791337fb09
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
🎯 @QichenZhu, thanks for reviewing and testing this PR! 🎉 An E/App issue has been created to issue payment here: #85339. |
All articles should have a # FAQ section, so it needs to be explicitly exempted from the rule requiring headings to start with an action verb or question word. Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
|
🚀 Deployed to staging by https://github.com/VictoriaExpensify in version: 9.3.40-0 🚀
|
|
🚀 Deployed to staging by https://github.com/VictoriaExpensify in version: 9.3.40-0 🚀
|
Explanation of Change
Strengthens the HelpDot governance rules in
HELP_AUTHORING_GUIDELINES.mdandHELPSITE_NAMING_CONVENTIONS.mdto prevent two categories of article violations that were occurring:Multiple
#headings: The phrase "One primary # heading" was ambiguous — "primary" could be read as allowing additional#headings. Replaced with "Exactly one # heading (the article title). No other # headings are allowed except # FAQ" and added explicit guidance on what to do when content seems to need its own#heading.Non-task-based headings: The forbidden heading list only covered 6 generic words and "task-based" was undefined. Expanded the forbidden list to include noun-only, topic-only, and platform-only headings. Added a definition of "task-based" (must start with action verb or question word) and added invalid-to-corrected examples.
Pre-publish checklist gaps: The checklist only checked heading depth, not count or task-based compliance. Updated to check for exactly one
#heading, task-based##headings, and no noun/topic/platform-only headings.Cross-reference in naming conventions: Added a note in
HELPSITE_NAMING_CONVENTIONS.mdreinforcing that headings referencing UI features must still follow the task-based heading rules.These changes were proposed in this analysis.
Fixed Issues
$ https://github.com/Expensify/Expensify/issues/606988
Tests
HELP_AUTHORING_GUIDELINES.mdSection 4 now says "Exactly one # heading" instead of "One primary # heading"HELPSITE_NAMING_CONVENTIONS.mdnow includes cross-reference note about task-based heading rulesOffline tests
N/A — documentation-only changes.
QA Steps
[No QA] — these are documentation governance files only, no application code changes.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectiontoggleReportand notonIconClick)src/languages/*files and using the translation methodSTYLE.md) were followedAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))npm run compress-svg)Avataris modified, I verified thatAvataris working as expected in all cases)Designlabel and/or tagged@Expensify/designso the design team can review the changes.ScrollViewcomponent to make it scrollable when more elements are added to the page.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.Screenshots/Videos
Android: Native
N/A — documentation-only changes
Android: mWeb Chrome
N/A — documentation-only changes
iOS: Native
N/A — documentation-only changes
iOS: mWeb Safari
N/A — documentation-only changes
MacOS: Chrome / Safari
N/A — documentation-only changes