Skip to content

[No QA] Docs: List all workspace roles in HELPSITE_NAMING_CONVENTIONS - #105258

Merged
stephanieelliott merged 1 commit into
mainfrom
claude-helpsiteNamingConventionsRoles
Oct 29, 2026
Merged

stephanieelliott merged 1 commit into
mainfrom
claude-helpsiteNamingConventionsRoles

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

The Roles section of docs/HELPSITE_NAMING_CONVENTIONS.md listed only workspace admin, workspace owner, and member as workspace roles. Writers had no guidance on how to write the newer roles, and help articles use mixed casing today (for example, "Card Admins", "card admins", and "Card admin").

This PR splits the list into two parts:

  • Workspace role names: workspace owner, workspace admin, auditor, card admin, people admin, payments admin, member, approve-only member, and guest.
  • Other role names: domain admin, account manager, account executive, and partner manager. These are unchanged.

The workspace roles match the roles a workspace admin can assign in the member role picker (WorkspaceMemberRoleList.tsx), plus the owner. The UI labels come from workspace.common.roleName in src/languages/en.ts. The internal editor role is left out because it isn't offered in the role picker.

The PR also adds examples for the new roles: "Ask a card admin to issue the card." (correct), "Choose Payments admin from the list of roles." (correct, UI label), and "Ask a Card Admin to issue the card." (incorrect).

This is a docs-only change. No app code changed, so the app lint, typecheck, and Jest suites don't apply. I couldn't run cspell or prettier locally on the file, so CI will be the first check for those.

@flodnv, please review the files changed and confirm they reflect the current behavior. Then post a new comment saying @MelvinBot mark this PR as ready for review.

Fixed Issues

$ #104885
PROPOSAL:

Tests

// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review"
// Please describe what tests you performed that validates your changed worked.

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: The human co-author must fill out the QA tests you ran before marking this PR as "ready for review".
// Please describe what QA needs to do to validate your changes and what areas do they need to test for regressions.

  • 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 verified any copy / text that was added to the app 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)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • 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)
  • 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 the PR adds or modifies the UI:
    • I asked an AI agent to review the changes for accessibility issues and addressed its findings.
    • I tested with a screen reader (VoiceOver on macOS) and verified all new/changed elements are reachable with a logical focus order.
    • I verified all new/changed elements have meaningful accessible names and roles.
    • I verified state changes are announced (e.g. checked/unchecked, expanded/collapsed, selected).
  • 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

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Co-authored-by: Florent De'Neve <flodnv@users.noreply.github.com>
@OSBotify

Copy link
Copy Markdown
Contributor

A preview of your ExpensifyHelp changes have been deployed to https://a5e146cc.helpdot.pages.dev ⚡️

Updated articles:

@flodnv flodnv changed the title Docs: List all workspace roles in HELPSITE_NAMING_CONVENTIONS [No QA] Docs: List all workspace roles in HELPSITE_NAMING_CONVENTIONS Oct 28, 2026
@flodnv
flodnv marked this pull request as ready for review October 28, 2026 14:11
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 28, 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-28T14:13:56.184668Z 518e0c6 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.

@melvin-bot
melvin-bot Bot requested review from deetergp and removed request for a team October 28, 2026 14:11
@melvin-bot

This comment has been minimized.

@flodnv
flodnv requested review from stephanieelliott and removed request for deetergp October 28, 2026 14:11
Comment thread docs/HELPSITE_NAMING_CONVENTIONS.md Resolved

@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: 518e0c6929

ℹ️ 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".

Comment thread docs/HELPSITE_NAMING_CONVENTIONS.md Resolved
@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR makes a small, focused change to docs/HELPSITE_NAMING_CONVENTIONS.md: it expands the Roles section by splitting the former flat "Role names" list into Workspace role names and Other role names, adds the newer workspace roles (auditor, card admin, people admin, payments admin, approve-only member, guest), and adds correct/incorrect capitalization examples for the new roles. The change is well-scoped, accurate, and improves writer guidance for roles that currently appear with inconsistent casing across help articles.

Scores Summary

  • Readability: 9/10 - The split into two labeled sublists is clear and scannable, and the added examples follow the existing correct/incorrect pattern.
  • AI Readiness: 8/10 - This is a governance reference file, not a published article, so article-level metadata/heading rules do not apply. The new content uses UI-exact role labels and realistic example phrasing, which strengthens retrieval accuracy for role terminology.
  • Style Compliance: 9/10 - The added examples correctly apply the lowercase-in-running-text rule and capitalize only when quoting a UI label (Payments admin, Workspace admin). Consistent with the sections surrounding the diff.

Key Findings

  • The new workspace role list matches the UI labels in src/languages/en.ts (workspace.common.roleName): Owner, Workspace admin, Auditor, Guest, Card admin, People admin, Payments admin, Approve-only, Member. Good sourcing.
  • Minor accuracy nuance: the UI label for the approve-only role is "Approve-only" (not "Approve-only member"), and the owner label renders as "Owner" (not "Workspace owner"). The running-text forms in the list ("approve-only member", "workspace owner") are reasonable prose, but writers quoting the UI label should use the exact strings. Consider a short parenthetical noting the exact UI labels for these two.
  • The added examples ("Ask a card admin to issue the card." vs. "Ask a Card Admin to issue the card.") directly address the mixed-casing problem the PR targets. Strong, practical guidance.
  • Scope is clean: docs-only, no article structure or heading rules in play.

Recommendations

  • Optional: clarify that the member-role picker UI labels for owner and approve-only are "Owner" and "Approve-only" so writers quoting those labels match the UI exactly.
  • Optional: the internal editor role is intentionally excluded (not in the role picker); a one-line note could prevent future writers from re-adding it.

Files Reviewed

  • docs/HELPSITE_NAMING_CONVENTIONS.md - Approve. Accurate, well-structured role-list expansion with correct capitalization examples; only minor optional clarifications suggested.

Note: This governance file change was evaluated against the help site authoring and naming conventions as the source of truth.

@stephanieelliott
stephanieelliott merged commit 81377dc into main Oct 29, 2026
30 of 34 checks passed
@stephanieelliott
stephanieelliott deleted the claude-helpsiteNamingConventionsRoles branch October 29, 2026 21:37
@OSBotify

Copy link
Copy Markdown
Contributor

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

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants