Repository navigation
[No QA] Docs: List all workspace roles in HELPSITE_NAMING_CONVENTIONS - #105258
Conversation
Co-authored-by: Florent De'Neve <flodnv@users.noreply.github.com>
|
A preview of your ExpensifyHelp changes have been deployed to https://a5e146cc.helpdot.pages.dev ⚡️ Updated articles: |
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. |
This comment has been minimized.
This comment has been minimized.
There was a problem hiding this comment.
💡 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".
HelpDot Documentation ReviewOverall AssessmentThis 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
Key Findings
Recommendations
Files Reviewed
Note: This governance file change was evaluated against the help site authoring and naming conventions as the source of truth. |
|
🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.5.27-0 🚀
|
Explanation of Change
The Roles section of
docs/HELPSITE_NAMING_CONVENTIONS.mdlisted 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:
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 fromworkspace.common.roleNameinsrc/languages/en.ts. The internaleditorrole 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
cspellorprettierlocally 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.
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.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectionAvatar, I verified the components usingAvatarare working as expected)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.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
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari