[Payment due @mananjadhav] [No QA] Update HELPSITE_NAMING_CONVENTIONS.md#90856
Conversation
|
@mananjadhav 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 modifies the governance document itself (HELPSITE_NAMING_CONVENTIONS.md) with two categories of changes: (1) removing the prohibition against calling the three dots menu "More" or "More menu," and (2) changing navigation instruction phrasing from action-oriented verbs to prepositional phrases. Both changes raise concerns about internal consistency and alignment with the broader authoring guidelines. Scores Summary
Key FindingsThree Dots Menu -- Removing "More" Prohibitions
Navigation Phrasing -- "In the navigation tabs"
Internal Consistency After Changes
Recommendations
Files Reviewed
Note: This PR modifies a governance document, so its impact extends to all future HelpDot articles authored under these rules. |
|
A preview of your ExpensifyHelp changes have been deployed to https://181d692f.helpdot.pages.dev ⚡️ Updated articles: |
mananjadhav
left a comment
There was a problem hiding this comment.
Approving as it's tagged No QA .
|
@NicolasBonet 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] |
|
🎯 @mananjadhav, thanks for reviewing and testing this PR! 🎉 A payment issue will be created for your review once this PR is deployed to production. If payment is not needed (e.g., regression PR review fix etc), react with 👎 to this comment to prevent the payment issue from being created. |
|
|
||
| Web: | ||
| Use the navigation tabs on the left. | ||
| In the navigation tabs on the left. |
There was a problem hiding this comment.
Readability / structure violation: "In the navigation tabs on the left." is a prepositional phrase fragment, not a complete instruction. The previous phrasing ("Use the navigation tabs on the left.") was an imperative sentence, which aligns with HELP_AUTHORING_GUIDELINES.md Section 5 requiring step instructions to be "Action-oriented." Since this governance file sets the standard for all HelpDot articles, the example phrasing should itself be a valid, complete instruction.
Consider restoring the imperative form or using another action verb, e.g.:
- "Use the navigation tabs on the left."
- "Click the navigation tabs on the left."
|
|
||
| Mobile: | ||
| Use the navigation tabs on the bottom. | ||
| In the navigation tabs on the bottom. |
There was a problem hiding this comment.
Readability / structure violation: Same issue as the Web example above -- "In the navigation tabs on the bottom." is a sentence fragment, not an actionable instruction. Step formatting standards in HELP_AUTHORING_GUIDELINES.md Section 5 require instructions to be "Action-oriented." Consider using an imperative form such as "Use the navigation tabs on the bottom." or "Tap the navigation tabs on the bottom."
| Use a unified sentence: | ||
|
|
||
| Click the navigation tabs (on the left on web, on the bottom on mobile). | ||
| In the navigation tabs (on the left on web, on the bottom on mobile). |
There was a problem hiding this comment.
Readability / structure violation: "In the navigation tabs (on the left on web, on the bottom on mobile)." is a prepositional phrase fragment, not a complete sentence. This is the unified-sentence template that article authors will copy, so it should model correct, action-oriented phrasing per HELP_AUTHORING_GUIDELINES.md Section 5. Consider restoring the imperative form, e.g.: "Click the navigation tabs (on the left on web, on the bottom on mobile)."
HelpDot Documentation ReviewOverall AssessmentThis PR makes two targeted changes to the governance document Scores Summary
Key FindingsPositive aspects:
Issues that should be addressed:
Recommendations
Files Reviewed
|
|
🚀 Deployed to staging by https://github.com/NicolasBonet in version: 9.3.78-0 🚀
Bundle Size Analysis (Sentry): |
|
🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.78-1 🚀
|
|
🤖 Payment issue created: #91353 |
Explanation of Change
Changes:
Fixed Issues
$ https://github.com/Expensify/Expensify/issues/637657
Tests
N/A no tests, this is a documentation change only.
Offline tests
QA Steps
// TODO: These must be filled out, or the issue title must include "[No QA]."
N/A no tests, this is a documentation change only.
Explanation of Change
Fixed Issues
$
PROPOSAL:
Tests
Offline tests
N/A
QA Steps
Same as tests.
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