Skip to content

[SIDE PANEL] Update the logic and fix help panel appearing without NVP#67159

Merged
Beamanator merged 13 commits intoExpensify:mainfrom
software-mansion-labs:chore/regenerate-help-content
Aug 21, 2025
Merged

[SIDE PANEL] Update the logic and fix help panel appearing without NVP#67159
Beamanator merged 13 commits intoExpensify:mainfrom
software-mansion-labs:chore/regenerate-help-content

Conversation

@blazejkustra
Copy link
Copy Markdown
Contributor

@blazejkustra blazejkustra commented Jul 25, 2025

Explanation of Change

  • Fix bug where help button was visible for people without the NVP
  • Add support for ordered list on help panel
  • Split chat help content into two sections
  • Regenerate help content

Fixed Issues

$ #68462
PROPOSAL: N/A

Tests

Prerequisites:

  • Run the following command in the web console using the same account:
Onyx.set('nvp_sidePanel', {})
  • Click the Help button, then close the help panel.

Open help panel on several pages and verify that the content is correct:

Private chat:
CleanShot 2025-08-13 at 18 55 44

Concierge:
CleanShot 2025-08-13 at 18 56 17

Create distance expense:
CleanShot 2025-08-13 at 18 59 11

Workspace:
CleanShot 2025-08-13 at 18 59 38

Open the help panel on all platforms and verify it works and animates correctly.

Offline tests

N/A

QA Steps

Same as tests +

Native Android:

  • Open the app with a new account
  • Try opening a page and go back as quickly as possible (with android back button)
  • Try it couple of times
  • Verify that Help button is not visible

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 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
untitled.webm
iOS: Native
Simulator.Screen.Recording.-.iPhone.16.Pro.-.2025-08-13.at.19.19.40.mp4
MacOS: Chrome / Safari
QuickTime.movie.mov

@blazejkustra blazejkustra changed the title Chore/regenerate help content Update the logic and fix help panel appearing without NVP Aug 13, 2025
@blazejkustra blazejkustra changed the title Update the logic and fix help panel appearing without NVP [SIDE PANEL] Update the logic and fix help panel appearing without NVP Aug 13, 2025
@blazejkustra blazejkustra marked this pull request as ready for review August 13, 2025 17:22
@blazejkustra blazejkustra requested a review from a team as a code owner August 13, 2025 17:22
@melvin-bot melvin-bot bot requested a review from dominictb August 13, 2025 17:22
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Aug 13, 2025

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

@melvin-bot melvin-bot bot removed the request for review from a team August 13, 2025 17:22
@blazejkustra
Copy link
Copy Markdown
Contributor Author

@dominictb what's your ETA on review?

@dominictb
Copy link
Copy Markdown
Contributor

It's midnight here. I'll review this in the morning (~ several hours).

@blazejkustra
Copy link
Copy Markdown
Contributor Author

Perfect, thank you! @dominictb

@blazejkustra
Copy link
Copy Markdown
Contributor Author

Bump on the above @dominictb

@dominictb
Copy link
Copy Markdown
Contributor

dominictb commented Aug 18, 2025

BUG: Text below NumberedList is missing top margin

Screenshot 2025-08-19 at 01 01 14

Does not happen if I used BulletList (I modified the markdown and regenerated the helpContentMap).

Screenshot 2025-08-19 at 01 09 49

@blazejkustra
Copy link
Copy Markdown
Contributor Author

Anything else other than this bug? @dominictb

Does not happen if I used BulletList (I modified the markdown and regenerated the helpContentMap).

I tried it locally and it looks different to me, have you added additional padding?

@dominictb
Copy link
Copy Markdown
Contributor

dominictb commented Aug 18, 2025

Anything else other than this bug?

I tried a nested numbered list and it didn't work. But it's broken for unordered list too so I think it's out of scope (we're just reusing the unordered list parsing function). Maybe we can make this External as it's a pretty minor UI bug.

Screenshot 2025-08-19 at 01 46 14 Screenshot 2025-08-19 at 01 59 33 Screenshot 2025-08-19 at 01 46 21

I tried it locally and it looks different to me, have you added additional padding?

No. What I did was:

  • Modify the markdown to use - unordered list
  • Run bundle exec jekyll build
  • Copy pasta help/_src/htmlContentMap.tsx to src/components/SidePanel/HelpContent/helpContentMap.tsx

@dominictb
Copy link
Copy Markdown
Contributor

dominictb commented Aug 18, 2025

The margin bug only happens if the text below the list is not a heading. Because the heading text itself already has top margin. For example:

## Adding Members
1. Under **Workspaces > [Workspace Name] > Members**, click **Invite Member**
2. Enter name, email, or phone number
3. Choose a role (defaults to Member)
4. Click **Invite**
**Alternative:** Share the workspace URL or QR code from **Account > Profile > Share**

@dominictb
Copy link
Copy Markdown
Contributor

That's all. Testing on mobile is all good.

@blazejkustra
Copy link
Copy Markdown
Contributor Author

After some trial and error, I finally managed to fix it!💡Here's the final result:

CleanShot 2025-08-19 at 16 52 20

@dominictb let me know wdyt 😄

@blazejkustra
Copy link
Copy Markdown
Contributor Author

Performance tests are flaky lately @dominictb, so don't mind it 🙏

@shawnborton
Copy link
Copy Markdown
Contributor

What's the ETA here?

@blazejkustra
Copy link
Copy Markdown
Contributor Author

@dominictb is going to review today

@dominictb
Copy link
Copy Markdown
Contributor

dominictb commented Aug 20, 2025

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 Screenshot_1755702322 Screenshot_1755702311 Screenshot_1755702306
Android: mWeb Chrome Screenshot_1755702196 Screenshot_1755702223
iOS: HybridApp simulator_screenshot_71D05916-C21C-42E2-95A8-968B9B348339 simulator_screenshot_F4462E5C-74D7-4214-A7D9-33BC816F8C30 simulator_screenshot_0A6693DF-64EB-455E-BC31-BDDCEB8935FB
iOS: mWeb Safari simulator_screenshot_98FA063A-F525-4300-AF6C-958013B67FD8 simulator_screenshot_F2712439-F945-4FA0-A67D-35E708F49CFA simulator_screenshot_22C60495-6CE6-44A6-AD6B-77BACB739D88
MacOS: Chrome / Safari Screenshot 2025-08-20 at 21 53 12 Screenshot 2025-08-20 at 21 54 57 Screenshot 2025-08-20 at 21 54 51 Screenshot 2025-08-20 at 21 54 38
MacOS: Desktop Screenshot 2025-08-20 at 21 57 14 Screenshot 2025-08-20 at 21 57 29

Copy link
Copy Markdown
Contributor

@dominictb dominictb left a comment

Choose a reason for hiding this comment

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

:shipit:

@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Aug 20, 2025

We did not find an internal engineer to review this PR, trying to assign a random engineer to #68462 as well as to this PR... Please reach out for help on Slack if no one gets assigned!

@melvin-bot melvin-bot bot requested a review from Beamanator August 20, 2025 15:12
Copy link
Copy Markdown
Contributor

@Beamanator Beamanator left a comment

Choose a reason for hiding this comment

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

Looking good to me!!

@Beamanator Beamanator merged commit ba97db7 into Expensify:main Aug 21, 2025
22 checks passed
@github-actions
Copy link
Copy Markdown
Contributor

🚀Deployed to NewHelp production! 🚀

(View deploy workflow run)

@OSBotify
Copy link
Copy Markdown
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/Beamanator in version: 9.1.98-0 🚀

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

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.1.98-12 🚀

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants