Skip to content

Add contextual help documentation for key user workflows#64944

Merged
twisterdotcom merged 6 commits intomainfrom
add-contextual-help-documentation
Jun 26, 2025
Merged

Add contextual help documentation for key user workflows#64944
twisterdotcom merged 6 commits intomainfrom
add-contextual-help-documentation

Conversation

@twisterdotcom
Copy link
Contributor

@twisterdotcom twisterdotcom commented Jun 25, 2025 •
edited
Loading

Explanation of Change

  • Create contextual help documentation system for side panel help pane
  • Add concise help content for core expense creation flows (distance, scan)
  • Add focused help content for workspace management (accounting integrations, members)
  • Follow established markdown format with frontmatter, structured sections, and related links
  • Content provides route-specific guidance optimized for side panel viewing
  • Focus on Expensify functionality rather than company-specific policies
  • Keep content concise and scannable for limited side pane space

Fixed Issues

https://github.com/Expensify/Expensify/issues/464009
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • 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
    • MacOS: Desktop
  • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • 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 shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • 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)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • 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 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 a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • 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
MacOS: Desktop

@twisterdotcom
Add contextual help documentation for key user workflows
c2e8dec 
- Add help content for expense creation flows (manual, scan, distance, amount)
- Add help content for workspace management (overview, members, categories, accounting)
- Add help content for workspace creation flow
- Follow established markdown format with frontmatter, structured sections, and related links
- Content provides route-specific guidance for side panel help system
@github-actions
Copy link
Contributor

github-actions bot commented Jun 25, 2025 •
edited
Loading

Your New Help changes have been deployed to https://27ae017e.newhelp.pages.dev ⚡️

@twisterdotcom
Refine contextual help for proof of concept
bfccbaf 
- Remove 5 help files to focus on core functionality
- Keep distance, scan, accounting, and members help content
- Make content concise and focused for side pane viewing
- Focus on Expensify functionality rather than company policies
- Add clear step-by-step instructions and practical tips
@twisterdotcom
Fix help file route structures to match ROUTES.ts definitions
e9ead75 
- Move distance help from create/expense/distance to :action/:iouType/distance/:transactionID/:reportID
- Move scan help from create/expense/scan to :action/:iouType/scan/:transactionID/:reportID
- Remove old create/expense directory structure
- Route structures now correctly match MONEY_REQUEST_STEP_DISTANCE and MONEY_REQUEST_STEP_SCAN definitions
@twisterdotcom
Fix routes to use CREATE_TAB instead of STEP routes
1371692 
- Move scan help to :action/:iouType/start/:transactionID/:reportID/scan/:backToReport (MONEY_REQUEST_CREATE_TAB_SCAN)
- Move distance help to :action/:iouType/start/:transactionID/:reportID/distance/:backToReport (MONEY_REQUEST_CREATE_TAB_DISTANCE)
- Remove old incorrect STEP route directories
- Routes now correctly match the CREATE_TAB flow which is the main expense creation flow
@twisterdotcom
Delete help/ref/:action/:iouType/start/:transactionID/:reportID/dista…
79550a5 
…nce/:backToReport/index.md
@twisterdotcom
Merge branch 'main' into add-contextual-help-documentation
6146f3e
blazejkustra
blazejkustra approved these changes Jun 26, 2025
View reviewed changes
Copy link
Contributor

@blazejkustra blazejkustra left a comment

Choose a reason for hiding this comment

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

Routes look good to me 👌

@twisterdotcom twisterdotcom marked this pull request as ready for review June 26, 2025 10:29
@twisterdotcom twisterdotcom requested a review from a team as a code owner June 26, 2025 10:29
@melvin-bot melvin-bot bot requested review from stitesExpensify and removed request for a team June 26, 2025 10:30
@melvin-bot
Copy link

melvin-bot bot commented Jun 26, 2025

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

@stitesExpensify
Copy link
Contributor

stitesExpensify commented Jun 26, 2025 •
edited
Loading

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 Issues section 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 Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • 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 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
    • MacOS: Desktop
  • 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 there are no new alerts related to the canBeMissing param for useOnyx
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • 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 shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • 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)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • 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 using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • 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
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • 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 any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • 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 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 a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • 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 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.
  • 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
MacOS: Desktop

@twisterdotcom twisterdotcom merged commit 93a63a6 into main Jun 26, 2025
14 of 16 checks passed
@twisterdotcom twisterdotcom deleted the add-contextual-help-documentation branch June 26, 2025 22:13
@github-actions
Copy link
Contributor

github-actions bot commented Jun 26, 2025

🚀Deployed to NewHelp production! 🚀

(View deploy workflow run)

@github-actions github-actions bot mentioned this pull request Jun 27, 2025
Closed
@github-actions
Copy link
Contributor

github-actions bot commented Jun 27, 2025

🚀 Deployed to staging by https://github.com/twisterdotcom in version: 9.1.72-0 🚀

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

1 similar comment
@github-actions
Copy link
Contributor

github-actions bot commented Jun 27, 2025

🚀 Deployed to staging by https://github.com/twisterdotcom in version: 9.1.72-0 🚀

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

@github-actions
Copy link
Contributor

github-actions bot commented Jun 30, 2025

🚀 Deployed to production by https://github.com/puneetlath in version: 9.1.72-10 🚀

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

@blazejkustra blazejkustra mentioned this pull request Jul 1, 2025
Merged
51 tasks
@twisterdotcom
Copy link
Contributor Author

twisterdotcom commented Jul 2, 2025

@blazejkustra what do we need to do to make this live?

image

@blazejkustra
Copy link
Contributor

blazejkustra commented Jul 2, 2025 •
edited
Loading

We're waiting for this PR to be merged (edit: merged), then with the staging release you should see it live

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

Reviewers

@stitesExpensify stitesExpensify stitesExpensify approved these changes

+1 more reviewer

@blazejkustra blazejkustra blazejkustra approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@twisterdotcom twisterdotcom

@maddylewis maddylewis

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@twisterdotcom @stitesExpensify @blazejkustra @maddylewis