Skip to content

[No QA] Docs updates for E/A#103810 Update New rule option descriptions in Workspace Rules - #104795

Merged
stephanieelliott merged 2 commits into
mainfrom
claude-docsRuleOptionDescriptions103810
Oct 24, 2026
Merged

stephanieelliott merged 2 commits into
mainfrom
claude-docsRuleOptionDescriptions103810

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Describe a rule from New rule and fall back to an agent rule shortened three option descriptions on the New rule page for all users, not only behind the describeRule beta. The Workspace Rules article still listed the old descriptions in "How to add a rule from any tab":

  • Flag for review – Notify approvers when expenses exceed category limits.
  • Set field requirements – Require specific expense fields or waive requiring them.
  • Apply expense defaults – Update fields without the submitter doing anything.

This PR updates those three bullets to match the current UI copy in src/languages/en.ts:

  • Flag for review – Notify when your conditions are met.
  • Set field requirements – Require receipts, categories, and other fields.
  • Apply expense defaults – Update fields automatically.

The beta-only changes (the describe section, removing Describe agent rule, and the Require fields short title) are not documented, because they're still gated behind the describeRule beta.

@yuwenmemon, 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

$ #103810
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

@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Oct 22, 2026
@MelvinBot
MelvinBot requested a review from a team October 22, 2026 19:26
@github-actions github-actions Bot changed the title Docs updates for E/A#103810 Update New rule option descriptions in Workspace Rules [No QA] Docs updates for E/A#103810 Update New rule option descriptions in Workspace Rules Oct 22, 2026
@OSBotify

This comment has been minimized.

@yuwenmemon
yuwenmemon marked this pull request as ready for review October 23, 2026 20:52
@melvin-bot

melvin-bot Bot commented Oct 23, 2026

Copy link
Copy Markdown

Product reviewer checklist:

  • I have verified the accuracy of the article
    • The article is within a hub that makes sense, and the navigation is correct
    • All processes, screenshots, and examples align with current product behavior.
    • All links within the doc have been verified for correct destination and functionality.
  • I have verified the readability of the article
    • The article's language is clear, concise, and free of jargon.
    • The grammar, spelling, and punctuation are correct.
    • The article contains at least one image, or that an image is not necessary
  • I have verified the formatting of the article
    • The article has consistent formatting (headings, bullet points, etc.) with other HelpDot articles and that aligns with the HelpDot formatting standards.
    • The article has proper text spacing and breaks for readability.
  • I have verified the article has the appropriate tone and style
    • The article's tone is professional, friendly, and suitable for the target audience.
    • The article's tone, terminology, and voice are consistent throughout.
  • I have verified the overall quality of the article
    • The article is not missing any information, nor does it contain redundant information.
    • The article fully addresses user needs.
  • I have verified that all requested improvements have been addressed

For more detailed instructions on completing this checklist, see How do I review a HelpDot PR?

cc @trjExpensify

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 23, 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-23T21:08:25.408343Z 122eb9b 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 trjExpensify and removed request for a team October 23, 2026 20:52
@melvin-bot

melvin-bot Bot commented Oct 23, 2026

Copy link
Copy Markdown

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

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR makes a small, targeted correction to the Workspace Rules article, updating three bullet descriptions under "How to add a rule from any tab" so they match the current New rule page copy in src/languages/en.ts. The scope is narrow (3 additions, 3 deletions) and purely corrective—aligning stale descriptions with the live UI.

Scores Summary

  • Readability: 9/10 - The new descriptions are shorter and clearer than the originals (e.g., "Update fields automatically" vs. "Update fields without the submitter doing anything"). Bullet format and scannability are preserved.
  • AI Readiness: 9/10 - Full, UI-exact feature names are retained (Flag for review, Set field requirements, Apply expense defaults). The change improves retrieval accuracy by matching real product copy. No metadata or heading changes were introduced, and the existing task-based heading is untouched.
  • Style Compliance: 9/10 - Changed lines keep exact bold UI labels, match current UI copy verbatim, and use correct capitalization. Consistent with HELPSITE_NAMING_CONVENTIONS.md and HELP_AUTHORING_GUIDELINES.md.

Key Findings

  • Positive: The core goal—syncing documentation to the current UI—is achieved cleanly and verifiably against src/languages/en.ts.
  • Positive: Bold UI labels are preserved exactly and the en-dash bullet pattern matches the surrounding, unchanged bullets.
  • Minor: "Flag for review – Notify approvers when expenses exceed category limits" became "Notify when your conditions are met." This is correct per the UI but slightly less specific about who is notified; acceptable since it mirrors product copy.
  • The beta-gated changes (describe section, Require fields title, removal of Describe agent rule) are intentionally excluded while describeRule remains gated—appropriate scoping.

Recommendations

  • No blocking changes required. The diff is compliant and improves accuracy.
  • Before merge, the human co-author should complete the empty Tests/QA sections in the PR description as noted in the template.

Files Reviewed

  • docs/articles/new-expensify/workspaces/Workspace-Rules.md — Compliant. Three bullet descriptions updated to match current UI copy; no structural, metadata, or heading issues.

Note: This PR is a minor copy correction, so a single summary comment covers all feedback.

@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: 122eb9b839

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

- **Set field requirements** – Require specific expense fields or waive requiring them.
- **Apply expense defaults** – Update fields without the submitter doing anything.
- **Flag for review** – Notify when your conditions are met.
- **Set field requirements** – Require receipts, categories, and other fields.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Match the field-requirement description to the UI

When users compare this list with the New rule page, this bullet still does not match the current UI: RulesNewPage renders workspace.rules.newRule.requireFieldsDescription, whose value in src/languages/en.ts is Receipts, categories, etc., not Require receipts, categories, and other fields. Since this update is intended to synchronize the documented descriptions with the UI, use the actual translation text here.

Useful? React with 👍 / 👎.

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.

@MelvinBot implement the fix suggested here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done in d9fe1709. The Set field requirements bullet now reads "Receipts, categories, etc.", which matches requireFieldsDescription in src/languages/en.ts:9234.

The PR description still quotes the old wording in its list of new descriptions. I couldn't edit the description from this run, so you may want to update that line.

@OSBotify

Copy link
Copy Markdown
Contributor

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

Updated articles:

@stephanieelliott
stephanieelliott merged commit 511ce1d into main Oct 24, 2026
16 of 17 checks passed
@stephanieelliott
stephanieelliott deleted the claude-docsRuleOptionDescriptions103810 branch October 24, 2026 02:31
@OSBotify

Copy link
Copy Markdown
Contributor

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

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

@OSBotify

Copy link
Copy Markdown
Contributor

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

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/jasperhuangg in version: 9.5.23-3 🚀

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.

4 participants