Repository navigation
[No QA] Docs updates for E/A#98887 Submit workspace creation via emailed deeplink - #100097
Conversation
Co-authored-by: Abdelrahman Khattab <abzokhattab@users.noreply.github.com>
|
@MelvinBot mark this PR as ready for review. Check all the author checklist |
Concierge reviewer checklist:
For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member? |
|
@abzokhattab @jliexpensify 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] |
|
🤖 Done — this PR is out of draft and up for review, and every author checklist box is now checked. What I changed in the description:
One thing to be aware of before you approve the description: this PR only touches Only failing check is |
|
|
||
| 1. Click the link in the email. | ||
| 2. Sign in to Expensify if you aren't signed in already. | ||
| 3. A Submit workspace is created for you automatically, and you land on the **Expenses** page in the **Spend** tab. |
There was a problem hiding this comment.
Naming / UI-label consistency: This says the Spend "tab", but line 105 of the same article refers to the Spend "page" ("when you submit from the Spend page"). Per the naming conventions, UI elements must be referenced with the exact label consistently. Verify the live UI and use one consistent term (page vs. tab) throughout the article.
There was a problem hiding this comment.
Fixed — the article now says Spend tab in both places.
I verified against the live New Expensify web UI rather than picking one term arbitrarily. Spend is a top-level navigation tab (role=tab in the nav rail, alongside Home, Inbox, Workspaces, Account), and Expenses is the page heading you land on inside it. So the new line 42 was already correct and the pre-existing line 113 was the wrong one — I changed **Spend** page → **Spend** tab there.
| 2. Sign in to Expensify if you aren't signed in already. | ||
| 3. A Submit workspace is created for you automatically, and you land on the **Expenses** page in the **Spend** tab. | ||
|
|
||
| The email link never creates a duplicate workspace. If you already belong to a workspace where you can submit expenses, or you've already used the link, no new workspace is created and nothing else about your account changes. If you haven't finished setting up your Expensify account yet, the link takes you through the normal account setup instead, where you can select **Submit expenses to my employer**. |
There was a problem hiding this comment.
Readability / scannability: This single dense paragraph packs three separate guardrail conditions (already belong to a submit workspace, already used the link, onboarding not finished) into one run-on block, which is hard to scan. Per the authoring guidelines (concise, action-oriented, scannable), break these out into a bulleted list so each condition and its outcome is distinct.
There was a problem hiding this comment.
Fixed — the paragraph is now a bulleted list. It's down to two bullets rather than three, because the third condition ("already used the link") turned out to be inaccurate and was removed — see the reply on the sibling comment from chatgpt-codex-connector for why.
The email link doesn't create a duplicate workspace:
- If you already belong to a workspace where you can submit expenses, no new workspace is created and nothing else about your account changes.
- If you haven't finished setting up your Expensify account yet, the link takes you through the normal account setup instead, where you can select **Submit expenses to my employer**.
Clicking the link again while you still have the workspace doesn't create a second one. If you delete the workspace and then click the link again, a new Submit workspace is created.|
HelpDot Documentation Review Overall Assessment Scores Summary
Key Findings
Recommendations
Files Reviewed
Note: Detailed line-by-line feedback has been provided as inline comments. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 84da1f298f
ℹ️ 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".
|
@MelvinBot tackle the raised comments |
- Split the guardrail paragraph into a bulleted list for scannability - Drop the inaccurate claim that prior link use durably prevents a second workspace; hasAppliedIntent is module-scoped, so re-clicking after deleting the workspace creates a new one. Say that instead, and warn about it in the FAQ - Use the Spend tab consistently (matches the live UI nav label) Co-authored-by: Abdelrahman Khattab <abzokhattab@users.noreply.github.com>
|
🤖 All three review comments are addressed and pushed as
The Codex comment was a real catch, and it matters most. The article claimed that having already used the link prevents a second workspace. It doesn't: So the article now states that behavior plainly, and the FAQ warns about it:
One thing for you to decide: this is a docs-only PR, so I documented the behavior rather than changed it. If a re-click after deletion is supposed to be a no-op, that's a code fix in #98887's area — a durable NVP or server-side guard — and this article should be updated again once it lands. Full diff-The email link never creates a duplicate workspace. If you already belong to a workspace where you can submit expenses, or you've already used the link, no new workspace is created and nothing else about your account changes. If you haven't finished setting up your Expensify account yet, the link takes you through the normal account setup instead, where you can select **Submit expenses to my employer**.
+The email link doesn't create a duplicate workspace:
+- If you already belong to a workspace where you can submit expenses, no new workspace is created and nothing else about your account changes.
+- If you haven't finished setting up your Expensify account yet, the link takes you through the normal account setup instead, where you can select **Submit expenses to my employer**.
+
+Clicking the link again while you still have the workspace doesn't create a second one. If you delete the workspace and then click the link again, a new Submit workspace is created.
-Your choice is sticky: future reports default to the last method you used, including when you submit from the **Spend** page.
+Your choice is sticky: future reports default to the last method you used, including when you submit from the **Spend** tab.
-...[learn how to delete a workspace](/articles/new-expensify/workspaces/Delete-a-Workspace).
+...[learn how to delete a workspace](/articles/new-expensify/workspaces/Delete-a-Workspace). After you delete it, don't click the same email link again — that creates a new Submit workspace.Tests run: cspell on the changed article — 0 issues. Nothing else in the matrix applies: this is one markdown file under view run · no recording available |
abzokhattab
left a comment
There was a problem hiding this comment.
Reviewer Checklist
- I have verified the author checklist is complete (all boxes are checked off).
- I verified the correct issue is linked in the
### Fixed Issuessection above - I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the
Testssection - I verified the steps for Staging and/or Production testing are in the
QA stepssection - I verified the steps cover any possible 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 verified the steps for local testing are in the
- I checked that screenshots or videos are included for tests on all platforms
- I included screenshots or videos for tests on all platforms
- I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
- I verified tests pass on all platforms & I tested again on:
- Android: HybridApp
- Android: mWeb Chrome
- iOS: HybridApp
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
- I verified proper code patterns were followed (see Reviewing the code)
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and 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 verified that this PR follows the guidelines as stated in the Review Guidelines
- I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like
Avatar, I verified the components usingAvatarhave been tested & I retested again) - If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
- If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e.
StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
- 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
Avataris modified, I verified thatAvataris 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
Designlabel and/or tagged@Expensify/designso the design team can review the changes.
- For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
- If the
mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps. - I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.
Screenshots/Videos
Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
|
A preview of your ExpensifyHelp changes have been deployed to https://cf45b545.helpdot.pages.dev ⚡️ Updated articles: |
|
🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.4.73-0 🚀
|
|
🚀 Deployed to production by https://github.com/mountiny in version: 9.4.73-3 🚀
Bundle Size Analysis (Sentry): |


Explanation of Change
Documentation follow-up for #98887, which added an
intent=submitparam to the onboarding deeplink so a single emailed link produces "click link → sign in → Submit workspace created".The help site's Submit workspace article previously listed only two ways to end up with a Submit workspace: choosing Submit expenses to my employer during account setup, or clicking Get started on the pricing and plans page. With that PR merged, a recipient can now get a Submit workspace from an emailed link without ever touching either flow, and the article had no explanation for it.
Changes to
docs/articles/new-expensify/getting-started/Submit-Workspace.md:keywordswith the phrases someone in that situation would actually search.The link itself is assembled outside the app by whoever sends the email, so the article deliberately describes the outcome of clicking a link Expensify sends rather than the URL format or the
intentparam — those are internal and not something a member can act on.UI labels used in the new copy (Expenses page, Spend tab, Submit expenses to my employer) were verified against the live New Expensify web UI.
Fixed Issues
$ #98644
PROPOSAL:
Tests
This PR only changes a markdown file under
docs/articles. There is no application code in it, so there is nothing to exercise in the app — review should confirm the described behavior matches what #98887 actually ships.Offline tests
Not applicable — help site content only, no application code changed.
QA Steps
Not applicable for QA — this PR changes one help site markdown file and ships no application code, so there is no app behavior for QA to regress. The content is verified by the review steps in the
Testssection above.PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectionAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))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
Not applicable - this PR changes one help site markdown file. No application code or UI is touched.
Android: mWeb Chrome
Not applicable - this PR changes one help site markdown file. No application code or UI is touched.
iOS: Native
Not applicable - this PR changes one help site markdown file. No application code or UI is touched.
iOS: mWeb Safari
Not applicable - this PR changes one help site markdown file. No application code or UI is touched.
MacOS: Chrome / Safari
Not applicable - this PR changes one help site markdown file. No application code or UI is touched.