Repository navigation
[No QA] Update HelpDot naming, navigation, and capitalization conventions - #103116
Conversation
…authoring guidance Co-authored-by: Stephanie Elliott <[email protected]>
Co-authored-by: Stephanie Elliott <[email protected]>
|
Fixed the failing cspell rejected the word "frontmatter" in two places: I replaced it with "metadata", the term these guides already use in their "Metadata Requirements" sections. cspell now passes locally on all 7 changed files.
|
|
@linhvovan29546 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] |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
@parasharrajat 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] |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
HelpDot Documentation ReviewOverall AssessmentThis PR updates the HelpDot governance and template files themselves (not published help articles). It significantly expands HELPSITE_NAMING_CONVENTIONS.md with new sections (Actions, Navigation Tabs/Paths/Menu, Fields, Bulk Actions, Color References, and a full Writing and Capitalization section), and threads consistent capitalization and UI-reference rules through HELP_AUTHORING_GUIDELINES.md, the TASK/TOPIC guideline variants, and all three templates. It also fixes a duplicate contentType/platform frontmatter block in TEMPLATE-task.md. The changes are coherent, cross-referenced, and raise the overall rigor of the spec. Scores Summary
Key Findings
Recommendations
Files Reviewed
Note: Detailed line-by-line feedback has been provided as inline comments. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 55a86645f5
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
A preview of your ExpensifyHelp changes have been deployed to https://3b48e48b.helpdot.pages.dev ⚡️ Updated articles: |
|
🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.5.8-0 🚀
|
|
@stephanieelliott @VictoriaExpensify ok to check off if no QA? |
|
Oops! Yes @izarutskaya, no QA on this! |
|
🚀 Deployed to production by https://github.com/cristipaval in version: 9.5.8-5 🚀
Bundle Size Analysis (Sentry): |
Explanation of Change
Updates the HelpDot authoring guidance so writers (and AI drafting tools) follow the newly aligned naming, navigation, and capitalization conventions.
docs/HELPSITE_NAMING_CONVENTIONS.md: Replaced with the agreed conventions. These cover select vs. choose, navigation tabs, navigation paths, the navigation menu (replacing the hamburger menu rule), More (⋮), platform instructions, toggles, fields, the selection bar, color, naming UI elements by function, and capitalization rules for titles, headings, roles, generic terms, and plans. The non-conflicting existing sections are kept: section references, cross-platform clarity, prohibited language, and deterministic writing.docs/HELP_AUTHORING_GUIDELINES.md,docs/HELP_AUTHORING_GUIDELINES_TASK.md,docs/HELP_AUTHORING_GUIDELINES_TOPIC.md: Link to the naming conventions, add the title-case title and sentence-case##heading rule, add select/navigation-path step rules, add validation checklist items, and lowercase generic terms in the examples.docs/TEMPLATE.md,docs/TEMPLATE-task.md,docs/TEMPLATE-topic.md: Use select instead of click, use bolded navigation paths, use the new "only available on web/mobile" wording, use lowercase roles and generic terms, and use title-case title examples. Also removes the duplicatecontentType: topicandplatformlines from the task template, and pointsTEMPLATE.mdnavigation guidance to the correct file.Interpretation note: the issue's "Article Titles and Headings" section has one bullet that says to use sentence case for the frontmatter
titleand#title. Its other bullets and examples use title case for titles, so this PR uses title case for the title and sentence case for##headings.The QA reviewer prompts (
.claude/agents/helpdot-inline-reviewer.md,.claude/agents/helpdot-summary-reviewer.md,.claude/commands/review-helpdot-pr.md) already readdocs/HELPSITE_NAMING_CONVENTIONS.mdas their source of truth, so they pick up the new rules. Suggested edits that list the new checks explicitly are in the linked issue.Fixed Issues
$ https://github.com/Expensify/Expensify/issues/689144
PROPOSAL:
Explanation of Change
Fixed Issues
$
PROPOSAL:
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