Skip to content

[No QA] Refractor Members pages for help site - #106171

Merged
yuwenmemon merged 12 commits into
mainfrom
helpsite-refractor-memberspages
Nov 11, 2026
Merged

yuwenmemon merged 12 commits into
mainfrom
helpsite-refractor-memberspages

Conversation

@stephanieelliott

Copy link
Copy Markdown
Contributor

@stephanieelliott stephanieelliott self-assigned this Nov 6, 2026
@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Nov 6, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 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-11-06T04:44:26.699161Z dbf1870 PR opened
ℹ️ 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.

@github-actions

github-actions Bot commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR refactors a single large article (Managing-Workspace-Members.md) into three focused articles: Invite Members to a Workspace, Manage Workspace Members and Access, and Understand Workspace Roles and Permissions. The split is a strong structural improvement that aligns with the one-primary-workflow-per-article principle, and the new articles add proper YAML metadata including internalScope. However, the diff contains several blocking defects: a filename with a space that breaks cross-links, inconsistent internal links, multiple typos, malformed bold navigation paths, h3 headings that violate the heading rules, and a malformed table.

Scores Summary

  • Readability: 6/10 - Well-organized and scannable, but typos (Choosse, invite a members directly) and unterminated bold in navigation paths hurt polish.
  • AI Readiness: 7/10 - Good task-based headings, full feature names, and complete metadata with internalScope. Loses points for h3 sub-headings (only h1 and h2 allowed) and a malformed table.
  • Style Compliance: 5/10 - Mostly follows naming conventions (select, navigation tabs, navigation paths), but broken internal links, a filename with a space, a .md link, and links inside/adjacent to steps are governance violations.

Key Findings

  • Blocking: The new file is named Understand-Workspace Roles-and-Permissions.md (space before Roles). Links to it are inconsistent: some use the space version, others the correct hyphenated Understand-Workspace-Roles-and-Permissions. Rename the file with hyphens and update every link.
  • Blocking: Malformed bold navigation paths in Invite-Members-to-a-Workspace.md: the Workspaces path is missing the closing bold markers and ends with a comma instead of a period. Appears in both the direct-invite and spreadsheet-import steps.
  • Typos: How do I invite a members directly? and Choosse the new role in the change-role steps.
  • Heading violations: three headings use h3 (What member fields can I import, Why cannot I change the authorized payers role, What settings admin roles can access). Only h1 and h2 are permitted; demote them to h2.
  • Malformed table: the What settings admin roles can access table has five column separators in the divider row but only four columns, so it renders incorrectly.
  • Link formatting: the Add Approvals link includes a .md extension; relative article links should omit it. Several links sit inside or adjacent to procedural steps; keep links in explanatory sentences, not step flow.
  • Minor style: the Related articles headings have a trailing colon and space and use space-indented bullets; the spec specifies a plain Related articles heading.
  • Positive: Clean workflow separation, strong internalScope definitions, correct use of select, navigation tabs with platform wording, lowercase roles in running text, and good labeled On web / On mobile instructions.

Recommendations

  • Priority 1: Rename the roles file to use hyphens and fix all references so cross-links resolve.
  • Priority 1: Fix the unterminated bold navigation paths and the two typos.
  • Priority 2: Demote all h3 headings to h2 and fix the malformed roles-access table.
  • Priority 2: Remove the .md extension from the Add Approvals link and move inline links out of step sequences.
  • Priority 3: Normalize the Related articles headings (no trailing colon, standard bullets).

Files Reviewed

  • Invite-Members-to-a-Workspace.md (new) - Good structure; blocked by malformed nav paths, typo, and inconsistent role-article link.
  • Manage-Workspace-Members-and-Access.md (new) - Solid; h3 headings, a typo, and a .md link need fixing.
  • Understand-Workspace Roles-and-Permissions.md (new) - Content is strong; filename-with-space and malformed table are blocking.
  • Managing-Workspace-Members.md (deleted) - Appropriately removed; content redistributed across the three new articles.

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

@melvin-bot
melvin-bot Bot removed the request for review from a team November 6, 2026 05:54
@melvin-bot

melvin-bot Bot commented Nov 6, 2026

Copy link
Copy Markdown

@justinpersaud @joekaufmanexpensify One of you needs to 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]

NOTE: It looks like docs/redirects.csv was modified in this PR. Please see this SO for special instructions on how to review changes to that file.

@stephanieelliott
stephanieelliott removed the request for review from justinpersaud November 6, 2026 06:00
@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@OSBotify

OSBotify commented Nov 6, 2026

Copy link
Copy Markdown
Contributor

@joekaufmanexpensify

Copy link
Copy Markdown
Contributor

Manage Workspace Members and Access | Cover changing roles, removing members individually or in bulk, filtering by role, setting display names, and downloading a CSV. Include the permissions and restrictions relevant to each action, plus a link to the existing ownership transfer article.

@stephanieelliott i noticed in OP of the issue, there is a reference to linking this new article to the existing trans ownership transfer article, but I don't see that in the draft article. Is that intentional?

@stephanieelliott

Copy link
Copy Markdown
Contributor Author

@joekaufmanexpensify it was intentional, but on second thought I decided may as well add it! Added a new section for this called ## How workspace ownership is assigned to Understand Workspace Roles and Permissions

@joekaufmanexpensify joekaufmanexpensify left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM

@joekaufmanexpensify

Copy link
Copy Markdown
Contributor

@stephanieelliott the PR has conflicts. Could you resolve before I approve/merge?

# Conflicts:
#	docs/articles/new-expensify/workspaces/Managing-Workspace-Members.md
#	docs/redirects.csv
@yuwenmemon
yuwenmemon merged commit 3627f1f into main Nov 11, 2026
8 of 9 checks passed
@yuwenmemon
yuwenmemon deleted the helpsite-refractor-memberspages branch November 11, 2026 23:05
@OSBotify OSBotify added the CP Staging marks PRs that have been CP'd to staging label Nov 11, 2026
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/yuwenmemon in version: 9.5.37-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/yuwenmemon in version: 9.5.37-1 🚀

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

Bundle Size Analysis (Sentry):

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

Labels

CP Staging marks PRs that have been CP'd to staging 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