[No QA] Integrations Error Revamp: Create folders for integration troubleshooting docs by stephanieelliott · Pull Request #84217 · Expensify/App

stephanieelliott · 2026-03-04T23:22:25Z

Master project issue https://github.com/Expensify/Expensify/issues/469226

Breaking main PR into smaller batches: #83106

Creates folders integration error messages

--

Explanation of Change

Creates folders integration error messages

Fixed Issues

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

Tests

Verify that no errors appear in the JS console

Offline tests

QA Steps

N/A, no tests

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

android.mp4

Android: mWeb Chrome

android.mweb.mp4

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

web.mp4

- Add Troubleshooting/Sync-Errors, Export-Errors, Connection-errors, Authentication-and-Login-errors under each connection integration (both platforms) - One Overview.md placeholder per subfolder; content to be added in follow-up PRs - Update createDocsRoutes to support section subfolders (fixes EISDIR)

melvin-bot · 2026-03-04T23:22:56Z

melvin-bot · 2026-03-04T23:22:58Z

@AndrewGable @RachCHopkins One of you needs to 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]

...nsify-classic/connections/accelo/Troubleshooting/Authentication-and-Login-errors/Overview.md

docs/articles/expensify-classic/connections/accelo/Troubleshooting/Export-Errors/Overview.md

...w-expensify/connections/netsuite/Troubleshooting/Authentication-and-Login-errors/Overview.md

github-actions · 2026-03-04T23:26:00Z

HelpDot Documentation Review

Overall Assessment

This PR creates the scaffolding for a new integration troubleshooting documentation structure by adding 48 placeholder Overview.md files across 4 error subcategories (Authentication-and-Login-errors, Connection-errors, Export-Errors, Sync-Errors) for 12 integration paths (7 Expensify Classic + 5 New Expensify). It also updates createDocsRoutes.ts to support one level of subfolder nesting within sections, which is a necessary infrastructure change to make these new directories discoverable in the docs routing system.

Because this is explicitly a structural/scaffolding PR (with real content coming in follow-up PRs), the scoring reflects the quality of what is proposed rather than penalizing for the intentional absence of final content.

Scores Summary

Readability: 4/10 - The placeholder content itself is clear and grammatically correct, but every file uses a generic "Overview" title and identical boilerplate text. This is acceptable for scaffolding, but the title and H1 heading directly violate the authoring guidelines (see below). The follow-up PR will need to correct this.
AI Readiness: 3/10 - Significant gaps in the proposed front matter: no keywords field, no internalScope field, no order field, and the title value "Overview" is explicitly listed as a forbidden heading in HELP_AUTHORING_GUIDELINES.md. These placeholders will be invisible to AI retrieval systems in their current state. Additionally, the description field contains meta-commentary ("under construction") rather than a meaningful summary.
Style Compliance: 5/10 - The folder naming convention is mostly sound and the overall organizational approach is reasonable. However, there are naming inconsistencies across the four subcategory folders (mixed casing conventions), and the placeholder content does not follow the required structural elements from the authoring spec.

Key Findings

Positive aspects:

The createDocsRoutes.ts change is well-structured and backward-compatible. It correctly handles the new subfolder nesting without breaking existing flat .md file resolution.
The overall categorization into Authentication-and-Login-errors, Connection-errors, Export-Errors, and Sync-Errors is a logical taxonomy that maps well to real user pain points.
Consistent structure is applied across all 12 integration paths, which will make the follow-up content PRs straightforward.

Issues that should be addressed:

Inconsistent folder naming conventions -- This is the most important structural issue. The four subcategory folders use two different casing patterns:
- Authentication-and-Login-errors (lowercase "errors")
- Connection-errors (lowercase "errors")
- Export-Errors (capitalized "Errors")
- Sync-Errors (capitalized "Errors")
Two folders use lowercase "errors" and two use title-case "Errors". This should be standardized before merging, as folder names become part of URLs and are difficult to change later without breaking links. Recommend standardizing all to Export-errors and Sync-errors (or capitalizing "Errors" in all four -- pick one convention and apply it consistently).
Forbidden "Overview" heading -- Per HELP_AUTHORING_GUIDELINES.md (Section 2), "Overview" is explicitly listed as a forbidden heading. Both the title front matter field and the # Overview H1 use this forbidden term. While these are placeholders, they will generate routes via createDocsRoutes.ts with href: "Authentication-and-Login-errors/Overview" and title "Authentication and Login errors/Overview". The slash in the generated title string (from getArticleObj) will look odd in navigation. Consider using a more descriptive placeholder name, such as Troubleshooting-authentication-errors.md instead of Overview.md, or at minimum be aware that the follow-up PR will need to rename these files.
Missing required front matter fields -- Per the authoring guidelines (Section 3), every article must include keywords and internalScope. These are absent from all 48 files. Even for placeholders, including skeleton values would be helpful (e.g., keywords: [] and internalScope: "").
Generated route title contains a slash -- When getArticleObj receives Authentication-and-Login-errors/Overview, the resulting title will be "Authentication and Login errors/Overview". This may render oddly in navigation menus. The toTitleCase function does not account for path separators in filenames. This is a latent issue in createDocsRoutes.ts that may need a fix either in this PR or a follow-up.
No order field in front matter -- The getOrderFromArticleFrontMatter function supports reading an order field, but none of the 48 new files include one. If these subcategories should appear in a specific order within the Troubleshooting section, order values should be added.

Code change review (createDocsRoutes.ts):

The logic correctly distinguishes between .md files and directories using fs.statSync.
The nested loop for reading subdirectory .md files is clean and follows the same pattern as the outer loop.
One minor note: fs.statSync is called twice for entries that are not .md files (once for the .isFile() check in the first condition, and once for the .isDirectory() check). This is functionally fine but could be optimized with a single stat call. This is a very minor concern and not blocking.
The change is backward-compatible -- existing flat .md files in sections continue to work identically.

Recommendations

[High Priority] Standardize folder naming -- Pick one casing convention for "errors/Errors" and apply it consistently across all four subcategory folder names before merging. This affects URLs and is painful to change after the fact.
[Medium Priority] Consider renaming Overview.md -- Even as a placeholder, using a name that is not on the forbidden headings list would be better practice. Consider names like Index.md or more descriptive names matching the intended final content (e.g., Common-authentication-errors.md). This would also avoid the slash-in-title issue in generated routes.
[Medium Priority] Add skeleton keywords and internalScope -- Even empty arrays/strings would signal to future authors that these fields are expected and required.
[Low Priority] Consider the title generation for nested paths -- The getArticleObj function will produce titles containing / for nested files. Decide whether this is acceptable for the navigation UI or whether toTitleCase should strip or replace path separators.
[Low Priority] Verify the Troubleshooting section exists -- The new subfolders are placed inside Troubleshooting/ directories that appear to be newly created by this PR. Confirm that the parent Troubleshooting section is properly registered (or will be registered) in the routing system, as the existing integration files (e.g., Netsuite-Troubleshooting.md) live at the hub level, not inside a Troubleshooting/ directory.

Files Reviewed

.github/scripts/createDocsRoutes.ts (+18/-4) -- Good backward-compatible change to support nested subfolders. Minor optimization opportunity with double statSync calls.
48 x Overview.md placeholder files (+9 lines each) -- Structurally identical. Naming inconsistency across subcategory folders. Missing required front matter fields per authoring guidelines. Forbidden "Overview" heading used.

Expensify Classic paths (28 files): accelo, certinia, netsuite, quickbooks-desktop, quickbooks-online, sage-intacct, xero -- each with 4 subcategory folders.

New Expensify paths (20 files): netsuite, quickbooks-desktop, quickbooks-online, sage-intacct, xero -- each with 4 subcategory folders.

Note: This review is based solely on the proposed diff. The placeholder nature of the documentation files is acknowledged -- the primary concerns are structural (folder naming consistency, forbidden heading usage) rather than content-related, as real content is expected in follow-up PRs.

OSBotify · 2026-03-04T23:27:22Z

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

Updated articles:

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 28e97447a9

ℹ️ About Codex in GitHub

Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

chatgpt-codex-connector · 2026-03-04T23:31:17Z

.github/scripts/createDocsRoutes.ts

+                    for (const file of fs.readdirSync(entryPath)) {
+                        if (!file.endsWith('.md')) continue;


Include markdown files nested beyond one subfolder

This loop only picks up .md files that are immediate children of entryPath, so any structure deeper than section/<subfolder>/<file>.md is silently skipped. In this commit the new troubleshooting docs are under paths like .../xero/Troubleshooting/Export-Errors/Overview.md (an extra directory level), which means createDocsRoutes will not add them to routes.yml, leaving these new pages undiscoverable from hub/section navigation.

Useful? React with 👍 / 👎.

stephanieelliott · 2026-03-04T23:37:49Z

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 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

OSBotify · 2026-03-05T19:17:59Z

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

stephanieelliott · 2026-03-05T19:29:23Z

@MelvinBot why aren't the nested folders showing in the help site UI?

MelvinBot · 2026-03-05T19:42:20Z

The nested articles from the Troubleshooting/ subfolders are being generated in the route data correctly — they appear in routes.yml as flat articles within each section (e.g., certinia, netsuite). You can confirm this at docs/_data/routes.yml:543-554, where the certinia section has entries like:

- href: Troubleshooting/Authentication-and-Login-errors/Overview
  title: Troubleshoot Authentication and Login Errors
- href: Troubleshooting/Connection-errors/Overview
  title: Troubleshoot Connection Errors

However, the reason they don't show as nested folders in the UI is that the rendering templates have no concept of sub-sections or folder grouping. Here's why:

section.html (line 17-23) renders ALL articles in a section as a flat list of cards. It doesn't distinguish between direct articles (like Configure-Certinia) and nested-folder articles (like Troubleshoot Export Errors) — they all appear as equal-level cards.
lhn-template.html (line 49-53) similarly renders all section articles as a flat list of links in the left-hand nav. There's no collapsible sub-grouping.
The data model itself (createDocsRoutes.ts:11-15) is flat: Platform → Hub → Section → Article[]. There is no SubSection type, so the Troubleshooting folder structure gets flattened into the articles array.

What you should see on a section page (e.g., the Certinia page): The four troubleshooting articles appear as regular article cards alongside existing articles — but without any "Troubleshooting" header or folder-like visual grouping.

To make nested folders show as actual folder groups in the UI, the rendering layer would need changes:

Add a subsections or groups concept to the Section type
Update section.html to render grouped article cards under sub-headings
Update lhn-template.html to render collapsible sub-groups within sections

This PR successfully set up the folder structure and route generation — the UI rendering for visual folder grouping would be a follow-up change.

stephanieelliott · 2026-03-05T19:43:23Z

@MelvinBot implement this change

MelvinBot · 2026-03-05T19:51:49Z

Draft PR created: #84318

This updates section.html and lhn-template.html to visually group articles from nested subfolders (like Troubleshooting/) under their own heading, instead of flattening them into the main article list.

What changed:

Section page (section.html): Direct articles render first as cards. Nested articles are grouped by their first path segment and rendered under an <h3> heading (e.g., "Troubleshooting").
Left-hand nav (lhn-template.html): Direct articles render first as flat links. Nested articles are grouped under a subfolder label with indented article links below.

Please mark it as "Ready for review" when it is ready for review.

OSBotify · 2026-03-06T04:16:58Z

🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.3.32-0 🚀

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

OSBotify · 2026-03-06T22:46:10Z

🚀 Deployed to production by https://github.com/blimpich in version: 9.3.32-3 🚀

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

stephanieelliott requested a review from a team as a code owner March 4, 2026 23:22

melvin-bot bot assigned stephanieelliott Mar 4, 2026

melvin-bot bot requested review from AndrewGable and RachCHopkins March 4, 2026 23:22

melvin-bot bot removed the request for review from a team March 4, 2026 23:22

Fix lint: add curly braces to if statements in createDocsRoutes

c012bfb