Skip to content

[No QA] Update HelpDot naming, navigation, and capitalization conventions - #103116

Merged
stephanieelliott merged 3 commits into
mainfrom
claude-helpdotNamingNavigationConventions
Oct 12, 2026
Merged

stephanieelliott merged 3 commits into
mainfrom
claude-helpdotNamingNavigationConventions

Conversation

@MelvinBot

@MelvinBot MelvinBot commented Oct 6, 2026 •

Copy link
Copy Markdown
Contributor

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 duplicate contentType: topic and platform lines from the task template, and points TEMPLATE.md navigation 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 title and # 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 read docs/HELPSITE_NAMING_CONVENTIONS.md as 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

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

@MelvinBot
MelvinBot requested a review from a team October 6, 2026 02:29
@MelvinBot

Copy link
Copy Markdown
Contributor Author

Fixed the failing spellcheck check in 55a8664.

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.

Check independent approval is also failing. That check clears when someone approves the PR, so it needs no code change.


view run

@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Oct 6, 2026
@stephanieelliott
stephanieelliott marked this pull request as ready for review October 6, 2026 02:36
@melvin-bot
melvin-bot Bot requested review from linhvovan29546 and removed request for a team October 6, 2026 02:36
@melvin-bot

melvin-bot Bot commented Oct 6, 2026

Copy link
Copy Markdown

@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]

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 6, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-06T02:48:23.676762Z 55a8664 Draft marked ready
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@stephanieelliott
stephanieelliott requested review from a team and removed request for linhvovan29546 October 6, 2026 02:36
@melvin-bot
melvin-bot Bot requested review from parasharrajat and removed request for a team October 6, 2026 02:37
@melvin-bot

melvin-bot Bot commented Oct 6, 2026

Copy link
Copy Markdown

@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]

@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This 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

  • Readability: 9/10 - Consistent Correct/Incorrect example blocks, clean tables, and tight phrasing make the rules easy to scan and apply.
  • AI Readiness: 8/10 - Explicit, deterministic rules with a named source of truth (src/languages/en.ts) and a consolidated capitalization section improve retrievability. Slight drift risk because capitalization rules are now stated in both the naming conventions and the authoring guidelines.
  • Style Compliance: 9/10 - These are governance docs, so they are not bound by the article-only heading-depth rule; the added H3 subheadings are reasonable here. Internal consistency with the new rules (select vs. click, lowercase roles/generic terms, title vs. sentence case, More three-dots, navigation paths) is strong.

Key Findings

  • Strong addition of a single, authoritative capitalization and UI-reference standard, with a clear source of truth and concrete Correct/Incorrect examples throughout.
  • Guideline and template files are updated in lockstep (validation checklists, step-formatting rules, and example headings all reflect the new title-case title / sentence-case section-heading convention), reducing contradictions.
  • Genuine bug fix: removes the duplicated contentType: topic / platform lines in TEMPLATE-task.md.
  • Minor duplication risk: capitalization rules now live in both HELPSITE_NAMING_CONVENTIONS.md and HELP_AUTHORING_GUIDELINES.md Section 2; keep one canonical (the naming conventions file is correctly cited as such) to avoid future drift.
  • The naming conventions file uses H3 subheadings; acceptable for a governance doc, but worth confirming any heading-depth tooling excludes governance/guideline files.

Recommendations

  • Confirm the navigation tab names (Home, Inbox, Spend, Workspaces, Account) and the More three-dots label exactly match current production UI / en.ts, since this doc is now the source of truth.
  • Consider having HELP_AUTHORING_GUIDELINES.md reference the naming conventions for capitalization rather than restating them, to keep a single canonical location.
  • Verify existing published articles are (or will be) migrated to the new lowercase roles/generic-terms and sentence-case section-heading conventions, since the guideline examples themselves changed (e.g., in a Workspace to in a workspace).

Files Reviewed

  • docs/HELPSITE_NAMING_CONVENTIONS.md - Major expansion; new Actions, Navigation, Fields, Color, and Writing/Capitalization sections. Strong.
  • docs/HELP_AUTHORING_GUIDELINES.md - Adds capitalization rules and expands the validation checklist and step-formatting guidance. Consistent.
  • docs/HELP_AUTHORING_GUIDELINES_TASK.md - Adds title/sentence-case and UI-reference rules; example headings updated. Consistent.
  • docs/HELP_AUTHORING_GUIDELINES_TOPIC.md - Same alignment applied to topic articles. Consistent.
  • docs/TEMPLATE.md - Updates navigation steps (select, navigation path), capitalization, and platform-availability wording. Good.
  • docs/TEMPLATE-task.md - Alignment updates plus removal of duplicate frontmatter keys. Good fix.
  • docs/TEMPLATE-topic.md - Title-case title examples and capitalization guidance added. Consistent.

Note: Detailed line-by-line feedback has been provided as inline comments.

@stephanieelliott stephanieelliott changed the title Update HelpDot naming, navigation, and capitalization conventions [HOLD] Update HelpDot naming, navigation, and capitalization conventions Oct 6, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 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".

Comment thread docs/HELPSITE_NAMING_CONVENTIONS.md Outdated
@stephanieelliott stephanieelliott changed the title [HOLD] Update HelpDot naming, navigation, and capitalization conventions [HOLD on 102832] Update HelpDot naming, navigation, and capitalization conventions Oct 6, 2026
@stephanieelliott
stephanieelliott requested a review from a team as a code owner October 7, 2026 02:35
@melvin-bot
melvin-bot Bot requested review from huult and removed request for a team October 7, 2026 02:35
@melvin-bot

melvin-bot Bot commented Oct 7, 2026

Copy link
Copy Markdown

@huult 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]

@OSBotify

OSBotify commented Oct 7, 2026

Copy link
Copy Markdown
Contributor

@stephanieelliott stephanieelliott changed the title [HOLD on 102832] Update HelpDot naming, navigation, and capitalization conventions Update HelpDot naming, navigation, and capitalization conventions Oct 12, 2026
@stephanieelliott
stephanieelliott merged commit d791a24 into main Oct 12, 2026
18 of 19 checks passed
@stephanieelliott
stephanieelliott deleted the claude-helpdotNamingNavigationConventions branch October 12, 2026 23:21
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.5.8-0 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

@izarutskaya

Copy link
Copy Markdown

@stephanieelliott @VictoriaExpensify ok to check off if no QA?

@stephanieelliott

Copy link
Copy Markdown
Contributor

Oops! Yes @izarutskaya, no QA on this!

@stephanieelliott stephanieelliott changed the title Update HelpDot naming, navigation, and capitalization conventions [No QA] Update HelpDot naming, navigation, and capitalization conventions Oct 13, 2026
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/cristipaval in version: 9.5.8-5 🚀

platform result
🕸 web 🕸 success ✅
🤖 android 🤖 success ✅
🍎 iOS 🍎 success ✅

Bundle Size Analysis (Sentry):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

HelpDot Apply this label if the issue relates to ExpensifyHelp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants