Skip to content

[No QA] Consolidated help docs: new-expensify/workspaces - #101958

Merged
VictoriaExpensify merged 56 commits into
mainfrom
helpsite-consolidated-new-expensify-workspaces
Sep 28, 2026
Merged

VictoriaExpensify merged 56 commits into
mainfrom
helpsite-consolidated-new-expensify-workspaces

Conversation

@stephanieelliott

@stephanieelliott stephanieelliott commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Consolidates 29 help doc PRs for new-expensify/workspaces into a single reviewable PR.

Included PRs

Test plan

  • Review combined doc changes for accuracy and conflicts
  • Verify no duplicate or contradictory guidance within the folder
  • No QA

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 26, 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-09-26T23:29:12.731302Z 2875678 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.

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR consolidates 29 help-doc changes across the new-expensify/workspaces folder (plus one AI-agents article) and adds one new article, Leave-a-Workspace.md. The dominant theme is a strong, consistent cleanup: migrating step verbs from Click to Select, collapsing multi-step navigation into the unified "Workspaces > [workspace name]" pattern, normalizing terminology (for example "Workspace Rules" -> "workspace rules" to match the UI), replacing SCREENSHOT placeholder comments with real images, and adding useful FAQs. The changes materially improve alignment with the governance files. A handful of small but real defects were introduced in the diff and should be fixed before merge.

Scores Summary

  • Readability: 9/10 - Steps are sequential, action-oriented, and scannable. Bulleted submission frequencies and workflow explanations in Workspace-Workflows.md read much better than the prior version. Minor: Copy-Workspace-Settings.md surfaces the ungrammatical UI string "1 invoice fields" (acceptable since it mirrors the UI, but worth a callout).
  • AI Readiness: 8/10 - New/updated headings are task-based (How/What/Where/Who), heading hierarchy stays at H1 and H2 (plus the FAQ heading), and internalScope/keywords were thoughtfully expanded (Create-expense-categories, Set-distance-rates, Leave-a-Workspace). The new article includes proper YAML with internalScope. Docked for the malformed description frontmatter introduced in Workspace-Workflows.md (see below), which degrades metadata quality.
  • Style Compliance: 8/10 - Broadly excellent adherence to the naming/navigation conventions: Select plus bold UI labels, unified nav sentence, correct three dots usage in the new article, sentence-case buttons. Docked for a placeholder alt-text string shipped to production and a couple of punctuation slips in steps.

Key Findings

  • Positive: Consistent, correct application of the navigation standard ("In the navigation tabs (on the left on web, on the bottom on mobile), select Workspaces > [workspace name]") and the Click -> Select migration across nearly every file.
  • Positive: Leave-a-Workspace.md is a clean, standards-compliant new article - single title heading, FAQ heading, task-based section headings, role-based breakdown, correct three dots formatting, and a complete internalScope.
  • Positive: Real screenshots replace placeholder comments in Import-Merchant-Rules.md and Workspace-Workflows.md; scope trimmed appropriately (e.g., removing the retired Updated vendor field from Merchant Rules articles).
  • Must fix - malformed metadata: Workspace-Workflows.md frontmatter is changed to "description: description: Configure your workspace..." (the word "description:" is duplicated inside the value).
  • Must fix - placeholder alt text: Import-Merchant-Rules.md ships an image with alt text "Insert alt text for accessibility here" (Rules_import-merchant-rules-mapping.png). Replace with descriptive alt text.
  • Must fix - punctuation in steps: Workspace-Rules.md "How to create Agent Rules" step reads "Select Agents," (trailing comma instead of a period).
  • Should fix - orphaned asset: docs/assets/images/General_basic-rules.png is added but not referenced by any article in the diff. Either wire it in or drop it.
  • Minor - intra-file consistency: some unchanged step blocks in Workspace-Rules.md (Categories section) still use Click, creating Click/Select inconsistency within the same file. Out of strict diff scope, but a quick follow-up would fully align these articles.

Recommendations

  • Priority: fix the duplicated description value in Workspace-Workflows.md, replace the placeholder alt text in Import-Merchant-Rules.md, and correct the trailing comma in the Workspace-Rules.md Agents step.
  • Remove or reference the orphaned General_basic-rules.png.
  • Optional: sweep the remaining Click occurrences in touched files so each article is internally consistent with the new Select standard.

Files Reviewed

  • ai-agents/Create-Agent-Rules.md - Good: updated flow, added confirmation strings and Agents tab references.
  • workspaces/Add-Approvals.md - Good: added approver-leaves reassignment case.
  • workspaces/Copy-Workspace-Settings.md - Good: new FAQ; UI string 1 invoice fields noted.
  • workspaces/Create-expense-categories.md - Good: Description hint sections plus expanded metadata; task-based headings.
  • workspaces/Duplicate-Workspace.md - Good: whitespace/format cleanup only.
  • workspaces/Enable-Invoice-Fields.md - Good: strong new FAQs on unique names and Collect-plan behavior.
  • workspaces/Enable-Report-Fields.md - Good: retitled to task-based, split create/delete into task headings, trimmed scope.
  • workspaces/Import-Merchant-Rules.md - Needs fix: placeholder alt text on new screenshot.
  • workspaces/Learn-About-Tracking-Taxes.md - Good: anchor link target updated.
  • workspaces/Leave-a-Workspace.md - New, standards-compliant.
  • workspaces/Managing-Workspace-Members.md - Good: casing fixes and a corrected typo (missing close paren).
  • workspaces/Set-distance-rates.md - Good: auto-generated rate plus currency/unit sections and FAQs; expanded keywords.
  • workspaces/Workspace-Merchant-Rules.md - Good: removed retired vendor references; tab-name correction.
  • workspaces/Workspace-Rules.md - Mostly good; fix trailing comma in Agents step.
  • workspaces/Workspace-Workflows.md - Needs fix: malformed description frontmatter.
  • assets/images (4 new PNGs) - General_basic-rules.png is unreferenced.

Note: This is a consolidated summary review. Fix the small defects called out above before merge.

@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: 2875678da6

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

@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Sep 26, 2026
@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@VictoriaExpensify
VictoriaExpensify merged commit 029845a into main Sep 28, 2026
14 of 16 checks passed
@VictoriaExpensify
VictoriaExpensify deleted the helpsite-consolidated-new-expensify-workspaces branch September 28, 2026 02:38
@melvin-bot melvin-bot Bot added the Emergency label Sep 28, 2026
@melvin-bot

melvin-bot Bot commented Sep 28, 2026

Copy link
Copy Markdown

@VictoriaExpensify looks like this was merged without a test passing. These checks had not passed on 8416e8b when it was merged:

  • checklist (no successful run)

Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/VictoriaExpensify in version: 9.4.95-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.4.95-4 🚀

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

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.

4 participants