Skip to content

Generate the help content map file on the fly #61279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 10 commits into from
May 10, 2025
Merged

Generate the help content map file on the fly #61279

merged 10 commits into from
May 10, 2025
+689 −33

Conversation

allroundexperts
Copy link
Contributor

@allroundexperts allroundexperts commented May 1, 2025 •
edited
Loading

Explanation of Change

This PR updates the build process for help site, such that it generates the help content tsx file on the fly.

Before
https://github.com/user-attachments/assets/ef99f78d-83d4-4c85-b7f5-06e7647eb205

After
https://github.com/user-attachments/assets/30f1a844-635c-428f-9f88-c7cf7dcae598

Fixed Issues

$ #61113
PROPOSAL: N/A

Tests

  1. Open the app and execute the following in console Onyx.set('nvp_sidePanel', {});
  2. Open Workspaces and click on the help icon. Note the content.
  3. Open any workspace and click on help icon again. Note the content.
  4. Open search, and click on help icon. Note the content.
  5. Go to help directory and execute bundle exec jekyll build
  6. Copy the content of help/_src/helpContentMap.tsx and paste it into src/components/SidePanel/HelpContent/helpContentMap.tsx.
  7. Repeat the steps 2-4 and verify that the content is same.
  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

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

Same as above

  • 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

N/A

Android: mWeb Chrome

N/A

iOS: Native

N/A

iOS: mWeb Safari

N/A

MacOS: Chrome / Safari

N/A

MacOS: Desktop

N/A

@allroundexperts allroundexperts mentioned this pull request May 1, 2025
Open
@allroundexperts allroundexperts marked this pull request as ready for review May 6, 2025 09:00
@allroundexperts allroundexperts requested a review from a team as a code owner May 6, 2025 09:00
@melvin-bot melvin-bot bot requested review from mananjadhav and removed request for a team May 6, 2025 09:00
@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented May 6, 2025

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

@allroundexperts allroundexperts changed the title [DRAFT] Generate the help content map file on the fly Generate the help content map file on the fly May 6, 2025
@mananjadhav
Copy link
Collaborator

Reviewing this PR.

mananjadhav
mananjadhav reviewed May 7, 2025
View reviewed changes
help/_plugins/SitePostRender.rb Outdated
end

def self.html_node_to_RN(node, indent_level = 0)
indent = ' ' * indent_level
Copy link
Collaborator

Choose a reason for hiding this comment

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

Should if add a check return "" if node.nil? ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hm... Why would it be nil?

mananjadhav
mananjadhav reviewed May 7, 2025
View reviewed changes
help/_plugins/SitePostRender.rb Outdated
"<TextLink href=\"#{href}\" style={styles.link}>#{link_text.strip}</TextLink>"

when 'text'
node.text
Copy link
Collaborator

Choose a reason for hiding this comment

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

return node.text.strip.empty? ? "" : node.text ?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why?

mananjadhav
mananjadhav reviewed May 7, 2025
View reviewed changes
Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Left a few comments.

help/_plugins/SitePostRender.rb Outdated
'' # handled in <ul>

when 'strong', 'b'
"<Text style={styles.textBold}>#{node.text}</Text>"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Do you think we need to be worried about any kind of nesting here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No. Do you have any concerns?

help/_plugins/SitePostRender.rb
# Remove the short title from the visible header text
header_text = header_text.sub(/^\[.*?\]\s*/, '')
header.content = header_text
# Check if the page is a reference page
Copy link
Collaborator

Choose a reason for hiding this comment

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

what's the effort for adding a few tests for the same?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Let's add the tests as a follow up?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sure.

@mananjadhav
Copy link
Collaborator

Thanks for the quick turnaround. I am working on another PR, will get right to it once that is done.

@mananjadhav
Copy link
Collaborator

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 NA
Android: mWeb Chrome NA
iOS: HybridApp NA
iOS: mWeb Safari NA
MacOS: Chrome / Safari NA
MacOS: Desktop NA

Before:

before-help-content-generator.mov

After:

after-help-content-generator.mov

mananjadhav
mananjadhav approved these changes May 7, 2025
View reviewed changes
Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Thanks for addressing the comments. Looks a lot cleaner.

@melvin-bot Melvin Bot
Copy link

melvin-bot bot commented May 7, 2025

We did not find an internal engineer to review this PR, trying to assign a random engineer to #61113 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 puneetlath May 7, 2025 23:01
mananjadhav
mananjadhav approved these changes May 7, 2025
View reviewed changes
Copy link
Collaborator

@mananjadhav mananjadhav left a comment

Choose a reason for hiding this comment

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

Approving again to assign an internal engineer.

@puneetlath puneetlath merged commit 4a3ae91 into Expensify:main May 10, 2025
10 of 11 checks passed
@github-actions GitHub Actions
Copy link
Contributor

🚀Deployed to NewHelp production! 🚀

(View deploy workflow run)

@github-actions github-actions bot mentioned this pull request May 13, 2025
Closed
@kavimuru
Copy link

@allroundexperts Can you help with the following?

Go to help directory and execute bundle exec jekyll build
Copy the content of help/_src/helpContentMap.tsx and paste it into src/components/SidePanel/HelpContent/helpContentMap.tsx.

@kavimuru
Copy link

@allroundexperts Can you please help with the following steps?

  1. Go to help directory and execute bundle exec jekyll build
  2. Copy the content of help/_src/helpContentMap.tsx and paste it into src/components/SidePanel/HelpContent/helpContentMap.tsx.

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.1.45-0 🚀

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

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to staging by https://github.com/puneetlath in version: 9.1.45-0 🚀

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

@kavimuru
Copy link

@allroundexperts incase you missed it

#61279 (comment)

@allroundexperts
Copy link
Contributor Author

Hi @kavimuru!
This involves running cli commands and then comparing the results. I think no QA is needed here, but @puneetlath or @quinthar can confirm.

@puneetlath
Copy link
Contributor

@allroundexperts if I'm understanding correctly, this PR is only part of the solution for #61113, is that right? Like should the codeless editing of the panel content be possible now? Or there are more PRs to make that possible?

@allroundexperts
Copy link
Contributor Author

@allroundexperts if I'm understanding correctly, this PR is only part of the solution for #61113, is that right? Like should the codeless editing of the panel content be possible now? Or there are more PRs to make that possible?

Not entirely possible right now. We'd need a script to transfer the generated file to the correct place.

@puneetlath
Copy link
Contributor

Ok I think we can check this off then since the side panel does seem to be working.

image

@github-actions GitHub Actions
Copy link
Contributor

🚀 Deployed to production by https://github.com/francoisl in version: 9.1.45-21 🚀

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

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

@puneetlath puneetlath puneetlath approved these changes

@mananjadhav mananjadhav mananjadhav approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@allroundexperts @mananjadhav @kavimuru @puneetlath