Create several placeholder files for side pane help content / update workspace overview content by maddylewis · Pull Request #65436 · Expensify/App

maddylewis · 2025-07-03T15:57:51Z

Explanation of Change

Create several placeholder files for side pane help content / update workspace overview content

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

Fixed Issues

N/A
PROPOSAL: N/A

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 / Chrome
- iOS / native
- iOS / 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- 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 verified the translation was requested/reviewed 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- 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.js 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 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
- If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
  - 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(themeColors.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 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.
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 author checklist, including those that don't apply to this PR.

Screenshots/Videosundefined

github-actions · 2025-07-03T15:58:56Z

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

melvin-bot · 2025-07-03T16:25:23Z

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

sumo-slonik · 2025-07-04T12:49:40Z

I'm just checking if everything works as it should. I've built your branch on my side and I'm starting the tests.

sumo-slonik · 2025-07-04T13:00:06Z

sumo-slonik · 2025-07-04T15:13:28Z

I tested it and, for the most part, it works well. During testing, I had to add some content to each file and check whether it displayed correctly. To do that, I had to make a small upgrade to the script that generates it:

Added support for parsing folders that have a "-" in their name.
Handled the case where the text may contain characters that are not allowed in HTML, such as "<" or ">".

The issues I noticed are:

The help doesn't work for Settings -> Workspace -> Reports. This is because the link uses reportsFields instead of report. The fix is a simple folder rename.

Can I include these fixes in this PR?

sumo-slonik · 2025-07-04T15:39:49Z

The only changes I would add:

Renamed the folder from reports to reportFields
Added missing directories, e.g. settings/workspaces/:policyID/more-features
Minor upgrade to the TSX generation script (as mentioned above)

I already have these changes locally — if you're okay with it, I’ll go ahead and add them.

inimaga · 2025-07-07T09:25:48Z

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

inimaga · 2025-07-07T09:48:48Z

The only changes I would add:

Renamed the folder from reports to r reportFields

Added missing directories, e.g. settings/workspaces/:policyID/more-features

Minor upgrade to the TSX generation script (as mentioned above)

I already have these changes locally — if you're okay with it, I’ll go ahead and add them.

@sumo-slonik Can you clarify whether the following; "Rename the folder from reports to r reportFields" would mean its not longer under settings? so; ref/r/reportFields or ref/settings/r/reportFields?

sumo-slonik · 2025-07-07T12:40:54Z

The point was that after going to Settings => Workspace and clicking on Reports, the URL doesn't contain /reports but /reportFields, which is why we should change the name of the directory — otherwise, the help panel content for this tab won't display correctly.

inimaga · 2025-07-07T20:21:14Z

Aah, then yeah, go ahead with the patch

…lewis-patch-1 # Conflicts: # src/components/SidePanel/HelpContent/helpContentMap.tsx

sumo-slonik · 2025-07-08T20:39:57Z

Before merging your PR, it's better to first merge mine into this one. The changes I made:

Moved the workspace to the correct directory after the URL change in the app
Changed report to reportFields
Small improvement to the script that generates help content from markdown so it works with the new folder structure

…-1_PR_1 Some fixes to help directories [No QA]

github-actions · 2025-07-09T11:28:01Z

🚀Deployed to NewHelp production! 🚀

(View deploy workflow run)

OSBotify · 2025-07-09T11:36:27Z

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

github-actions · 2025-07-10T07:26:39Z

🚀 Deployed to staging by https://github.com/inimaga in version: 9.1.79-0 🚀

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

izarutskaya · 2025-07-10T07:41:28Z

@maddylewis Do we need any QA for this?

github-actions · 2025-07-11T17:38:42Z

🚀 Deployed to production by https://github.com/Julesssss in version: 9.1.79-11 🚀

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

Create index.md

ede1196

maddylewis added 18 commits July 3, 2025 12:02

Create index.md

3575991

Create index.md

a963e60

Create index.md

1a4e7a5

Create index.md

1939b19

Create index.md

2181a09

Create index.md

4042d87

Create index.md

3e2c6e0

Create index.md

284e2fc

Create index.md

524a5a8

Create index.md

a20f847

Create index.md

a269811

Delete help/ref/settings/workspaces/:policyID/expensify-cards directory

89ab602

Create index.md

5316451

Create index.md

5e78315

Create index.md

6e08a02

Create index.md

330bff4

Update index.md

a1bd038

Update index.md

39fd8e6

maddylewis changed the title ~~Create index.md~~ Create several placeholder files for side pane help content Jul 3, 2025

maddylewis changed the title ~~Create several placeholder files for side pane help content~~ Create several placeholder files for side pane help content / update workspace overview content Jul 3, 2025

maddylewis self-assigned this Jul 3, 2025

maddylewis added this to [#whatsnext] #retain Jul 3, 2025

maddylewis moved this to HIGH in [#whatsnext] #retain Jul 3, 2025

maddylewis marked this pull request as ready for review July 3, 2025 16:24

maddylewis requested a review from a team as a code owner July 3, 2025 16:24

melvin-bot bot requested review from inimaga and removed request for a team July 3, 2025 16:25

regenerate content for .md help panel

c1b8316

update rb script, regenerate tsx map and add missing folder

5c5c709

maddylewis requested review from sumo-slonik and removed request for kubabutkiewicz July 8, 2025 14:07

puneetlath and others added 3 commits July 8, 2025 11:34

Merge branch 'main' into maddylewis-patch-1

412d6ca

Merge remote-tracking branch 'upstream/maddylewis-patch-1' into maddy…

b3d2065

…lewis-patch-1 # Conflicts: # src/components/SidePanel/HelpContent/helpContentMap.tsx

refactor workspace directory

fe69fb3

inimaga mentioned this pull request Jul 9, 2025

Some fixes to help directories [No QA] #65686

Merged

51 tasks

sumo-slonik and others added 2 commits July 9, 2025 11:49

fix script

e1c0472

Merge pull request #65686 from software-mansion-labs/maddylewis-patch…

dc252fb

…-1_PR_1 Some fixes to help directories [No QA]

sumo-slonik approved these changes Jul 9, 2025

View reviewed changes

inimaga approved these changes Jul 9, 2025

View reviewed changes

inimaga merged commit dcecca2 into main Jul 9, 2025
24 checks passed

inimaga deleted the maddylewis-patch-1 branch July 9, 2025 11:27

github-project-automation bot moved this from HIGH to DONE in [#whatsnext] #retain Jul 9, 2025

github-actions bot mentioned this pull request Jul 10, 2025

Deploy Checklist: New Expensify 2025-07-10 #65809

Closed

77 tasks

Conversation

maddylewis commented Jul 3, 2025 • edited by inimaga Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation of Change

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videosundefined

Uh oh!

github-actions bot commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

melvin-bot bot commented Jul 3, 2025

Uh oh!

sumo-slonik commented Jul 4, 2025

Uh oh!

sumo-slonik commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sumo-slonik commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sumo-slonik commented Jul 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

inimaga commented Jul 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer Checklist

Screenshots/Videos

Uh oh!

inimaga commented Jul 7, 2025

Uh oh!

sumo-slonik commented Jul 7, 2025

Uh oh!

inimaga commented Jul 7, 2025

Uh oh!

sumo-slonik commented Jul 8, 2025

Uh oh!

Uh oh!

github-actions bot commented Jul 9, 2025

Uh oh!

OSBotify commented Jul 9, 2025

Uh oh!

github-actions bot commented Jul 10, 2025

Uh oh!

izarutskaya commented Jul 10, 2025

Uh oh!

github-actions bot commented Jul 11, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

maddylewis commented Jul 3, 2025 •

edited by inimaga

Loading

github-actions bot commented Jul 3, 2025 •

edited

Loading

sumo-slonik commented Jul 4, 2025 •

edited

Loading

sumo-slonik commented Jul 4, 2025 •

edited

Loading

sumo-slonik commented Jul 4, 2025 •

edited

Loading

inimaga commented Jul 7, 2025 •

edited

Loading