Skip to content

[No QA] Display nested doc folders as grouped sections in help site UI#84318

Merged
MonilBhavsar merged 3 commits intomainfrom
claude-docsNestedFolderUI
Mar 6, 2026
Merged

[No QA] Display nested doc folders as grouped sections in help site UI#84318
MonilBhavsar merged 3 commits intomainfrom
claude-docsNestedFolderUI

Conversation

@MelvinBot
Copy link
Contributor

@MelvinBot MelvinBot commented Mar 5, 2026 •
edited
Loading

Follow-up to #84217

Explanation of Change

PR #84217 added nested folder structure for integration troubleshooting docs (e.g., Troubleshooting/Export-Errors/Overview.md). The createDocsRoutes.ts script correctly generates route data with these nested articles, but the rendering templates (section.html and lhn-template.html) were flattening all articles into one list — so the folder grouping was invisible in the UI.

This PR updates both templates to detect articles with nested paths (containing / in their href) and visually group them under their subfolder headings. The full hierarchy is preserved:

Section > Troubleshooting > Error Category > Article(s)

What changed:

  • section.html: Direct articles render first in the main cards grid. Nested articles are grouped by top-level folder (e.g., "Troubleshooting") with an <h3> heading, then further grouped by sub-folder (e.g., "Authentication and Login errors") with <h4> headings and article cards underneath each.
  • lhn-template.html: Direct articles render first as flat links. Nested articles are grouped under a top-level subfolder label, then further nested under sub-subfolder labels with article links below each.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/469226
PROPOSAL: N/A

Tests

  1. Navigate to an integration section page that has nested troubleshooting folders (e.g., Expensify Classic > Connections > Certinia)
  2. Verify direct articles (Configure Certinia, Connect To Certinia, etc.) appear as cards in the main section
  3. Verify a "Troubleshooting" heading (h3) appears below the direct articles
  4. Verify sub-headings (h4) appear under Troubleshooting for each error category: "Authentication and Login errors", "Connection errors", "Export Errors", "Sync Errors"
  5. Verify article cards appear under each error category sub-heading (e.g., the "Troubleshoot Export Errors" article appears under the "Export Errors" sub-heading)
  6. Verify clicking a nested article card navigates to the correct article page
  7. Verify the left-hand navigation shows direct articles, then a "Troubleshooting" group containing sub-groups for each error category, each with their article links nested beneath
  8. Verify the same structure works for other integrations with the same folder pattern (e.g., QuickBooks Online, NetSuite, Xero, Sage Intacct)
  • Verify that no errors appear in the JS console

Offline tests

N/A — docs site only

QA Steps

N/A, no QA — docs rendering only

  • 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
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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 — docs site changes only, will be visible in Cloudflare Pages preview

Android: mWeb Chrome

N/A — docs site changes only, will be visible in Cloudflare Pages preview

iOS: Native

N/A — docs site changes only, will be visible in Cloudflare Pages preview

iOS: mWeb Safari

N/A — docs site changes only, will be visible in Cloudflare Pages preview

MacOS: Chrome / Safari

N/A — docs site changes only, will be visible in Cloudflare Pages preview

@MelvinBot @stephanieelliott
Display nested doc folders as grouped sections in UI
d5c325c 
Updates section.html and lhn-template.html to visually group
articles from nested subfolders (e.g. Troubleshooting/) under
their own heading instead of flattening them into the main
article list.

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot MelvinBot requested a review from a team March 5, 2026 19:51
@MelvinBot MelvinBot mentioned this pull request Mar 5, 2026
Merged
52 tasks
@MelvinBot @stephanieelliott
Fix: Add 'subfolders' to cspell dictionary
4795342 
Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot
Copy link
Contributor Author

MelvinBot commented Mar 5, 2026

Fixed the failing spellcheck check. The word "subfolders" (used in both lhn-template.html and section.html) was not in the cspell dictionary. Added it to cspell.json.

@stephanieelliott stephanieelliott marked this pull request as ready for review March 5, 2026 19:58
@melvin-bot melvin-bot bot requested review from ChavdaSachin and removed request for a team March 5, 2026 19:58
@melvin-bot
Copy link

melvin-bot bot commented Mar 5, 2026

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

@stephanieelliott stephanieelliott removed the request for review from ChavdaSachin March 5, 2026 20:01
@stephanieelliott
Copy link
Contributor

stephanieelliott commented Mar 5, 2026

@MelvinBot this is still not quite right :

  1. Verify a "Troubleshooting" heading appears below the direct articles
  2. Verify troubleshooting sub-articles (Troubleshoot Authentication and Login Errors, Troubleshoot Connection Errors, etc.) appear as cards under the Troubleshooting heading

Troubleshoot Authentication and Login Errors, , Troubleshoot Connection Errors, etc. are nested folders UNDER the Troubleshooting heading, which each contain articles. So the structure should be:

Expensify Classic > Connections > Certinia> Troubleshooting > Authentication and Login Errors > [article] [article]
Expensify Classic > Connections > Certinia> Troubleshooting > Connection Errors> [article] [article]

@MelvinBot @stephanieelliott
Fix: Add multi-level nesting for troubleshooting subfolder groups
f55ef82 
The templates were only grouping by the first path segment (e.g.,
"Troubleshooting"), rendering all nested articles flat under that
heading. The actual folder structure has an additional level:
Troubleshooting > Authentication-and-Login-errors > Overview.md

Updated both section.html and lhn-template.html to detect 3-segment
article paths and render them with sub-headings for each error
category (e.g., "Authentication and Login errors", "Connection errors")
beneath the top-level "Troubleshooting" heading.

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot MelvinBot requested a review from a team as a code owner March 5, 2026 20:08
@melvin-bot melvin-bot bot requested review from brunovjk and removed request for a team March 5, 2026 20:08
@melvin-bot
Copy link

melvin-bot bot commented Mar 5, 2026

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 5, 2026 •
edited
Loading

A preview of your ExpensifyHelp changes have been deployed to https://head.helpdot.pages.dev ⚡️

@MelvinBot
Copy link
Contributor Author

MelvinBot commented Mar 5, 2026

Good catch — the templates were only grouping by the first path segment (Troubleshooting), so all the sub-category articles were rendering flat under that heading instead of being nested further.

I've updated both section.html and lhn-template.html to support the full 3-level hierarchy:

Main section (section.html):

  • Troubleshooting (h3 heading)
    • Authentication and Login errors (h4 sub-heading)
      • Article card(s)
    • Connection errors (h4 sub-heading)
      • Article card(s)
    • Export Errors (h4 sub-heading)
      • Article card(s)
    • Sync Errors (h4 sub-heading)
      • Article card(s)

Left-hand navigation (lhn-template.html):

  • Troubleshooting
    • Authentication and Login errors
      • article link(s)
    • Connection errors
      • article link(s)
    • etc.

Also updated the PR test steps to reflect the correct expected structure. The Cloudflare Pages preview should show the updated rendering once the deploy finishes.

@stephanieelliott
Copy link
Contributor

stephanieelliott commented Mar 5, 2026

Confirmed this looks good:

image

@stephanieelliott
Copy link
Contributor

stephanieelliott commented Mar 6, 2026

@MelvinBot does this PR require an engineering reviewer, or can anyone with write access approve and merge it?

@MelvinBot
Copy link
Contributor Author

MelvinBot commented Mar 6, 2026

Based on what's documented in the repo's contributing guides:

  • The standard Expensify/App review process requires at least one internal engineer review (via @Expensify/pullerbear)
  • There's no specific CODEOWNERS entry for docs/_includes/ templates — only docs/articles/ has a dedicated reviewer assignment
  • The contributing guides don't document any exemption from engineering review for docs-only changes

That said, this PR modifies Liquid/HTML templates (section.html, lhn-template.html) and the cspell.json dictionary — it's not purely content changes but template logic. I'd defer to your team's judgment on whether the template logic warrants an engineering eye or if someone familiar with the docs site structure is sufficient.

@MonilBhavsar
Copy link
Contributor

MonilBhavsar commented Mar 6, 2026 •
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
  • 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 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

@MelvinBot
Copy link
Contributor Author

MelvinBot commented Mar 6, 2026

All checks on this PR are currently passing. There was a previous Spell check failure, but it has since been re-run and now passes. No fix is needed at this time.

@MonilBhavsar MonilBhavsar merged commit 9889d0e into main Mar 6, 2026
19 of 20 checks passed
@MonilBhavsar MonilBhavsar deleted the claude-docsNestedFolderUI branch March 6, 2026 05:16
@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

🚧 @MonilBhavsar has triggered a test Expensify/App build. You can view the workflow run here.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 6, 2026

🧪🧪 Use the links below to test this adhoc build on Android, iOS, and Web. Happy testing! 🧪🧪
Built from App PR #84318.

Android 🤖 iOS 🍎
https://ad-hoc-expensify-cash.s3.us-east-1.amazonaws.com/rock-artifacts/ad-hoc/rock-android-Adhoc-9889d0e-5430cbd-9eba66f84415d5769f4f6c4deadc0b5869c2bc16/index.html https://ad-hoc-expensify-cash.s3.us-east-1.amazonaws.com/rock-artifacts/ad-hoc/rock-ios-device-AdHoc-9889d0e-5430cbd-40aca5860ad240782784277d27d7a632bce92337/index.html
Android iOS
Web 🕸️
https://84318.pr-testing.expensify.com
Web

👀 View the workflow run that generated this build 👀

@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2026

✋ 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 OSBotify mentioned this pull request Mar 6, 2026
Closed
52 tasks
@OSBotify
Copy link
Contributor

OSBotify commented Mar 6, 2026

🚀 Deployed to staging by https://github.com/MonilBhavsar in version: 9.3.33-0 🚀

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

@OSBotify
Copy link
Contributor

OSBotify commented Mar 9, 2026

🚀 Deployed to production by https://github.com/luacmartins in version: 9.3.33-5 🚀

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

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

Reviewers

@MonilBhavsar MonilBhavsar MonilBhavsar approved these changes

@brunovjk brunovjk Awaiting requested review from brunovjk

Assignees

@stephanieelliott stephanieelliott

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@MelvinBot @stephanieelliott @OSBotify @MonilBhavsar