Skip to content

[No QA] Re-land billing docs hub with lint-safe route helpers#95786

Open
stephanieelliott wants to merge 12 commits into
mainfrom
helpsite-billing-articles-v2
Open

[No QA] Re-land billing docs hub with lint-safe route helpers#95786
stephanieelliott wants to merge 12 commits into
mainfrom
helpsite-billing-articles-v2

Conversation

@stephanieelliott

@stephanieelliott stephanieelliott commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

Summary

Lint-safe changes in createDocsRoutes.ts

  • Added runtime type guards for yaml.load() results when reading article order front matter and section _meta.yml files.
  • Added flatSections to the Hub type to avoid an unsafe cast.
  • Only the grandfathered as DocsRoutes assertion remains (1 total, baseline allows 3).

Test plan

  • Verify lint / ESLint check passes
  • Run npm run createDocsRoutes and confirm docs/_data/routes.yml generates successfully
  • Confirm billing hub cards and sidebar reflect the new subfolder structure and custom article/section ordering
  • Verify removed legacy flat billing articles no longer appear in navigation

Made with Cursor

Explanation of Change

Fixed Issues

$
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

N/A

QA Steps

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

Restore the billing-and-subscriptions hub reorganization from #95101 and replace unsafe YAML type assertions with runtime type guards so the file stays within the eslint-seatbelt baseline.

Co-authored-by: Cursor <cursoragent@cursor.com>
@stephanieelliott stephanieelliott requested a review from a team as a code owner July 10, 2026 07:27
@melvin-bot

melvin-bot Bot commented Jul 10, 2026

Copy link
Copy Markdown

Concierge reviewer checklist:

  • I have verified the accuracy of the article
    • The article is within a hub that makes sense, and the navigation is correct
    • All processes, screenshots, and examples align with current product behavior.
    • All links within the doc have been verified for correct destination and functionality.
  • I have verified the readability of the article
    • The article's language is clear, concise, and free of jargon.
    • The grammar, spelling, and punctuation are correct.
    • The article contains at least one image, or that an image is not necessary
  • I have verified the formatting of the article
    • The article has consistent formatting (headings, bullet points, etc.) with other HelpDot articles and that aligns with the HelpDot formatting standards.
    • The article has proper text spacing and breaks for readability.
  • I have verified the article has the appropriate tone and style
    • The article's tone is professional, friendly, and suitable for the target audience.
    • The article's tone, terminology, and voice are consistent throughout.
  • I have verified the overall quality of the article
    • The article is not missing any information, nor does it contain redundant information.
    • The article fully addresses user needs.
  • I have verified that all requested improvements have been addressed

For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member?

cc @lschurr

@melvin-bot melvin-bot Bot requested review from arosiclair and lschurr and removed request for a team July 10, 2026 07:28
@melvin-bot

melvin-bot Bot commented Jul 10, 2026

Copy link
Copy Markdown

@arosiclair @lschurr 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]

@OSBotify

This comment has been minimized.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e40c088e4d

ℹ️ 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".

Comment thread docs/redirects.csv
Comment on lines +1011 to +1012
https://help.expensify.com/articles/new-expensify/billing-and-subscriptions/manage-billing/resolve-billing-issues/Understand-Why-Billing-Issues-Occur,https://help.expensify.com/articles/new-expensify/billing-and-subscriptions/manage-your-subscription-and-billing/manage-billing/resolve-billing-issues/Understand-Why-Billing-Issues-Occur
https://help.expensify.com/articles/new-expensify/billing-and-subscriptions/manage-billing/resolve-billing-issues/Fix-a-Billing-Issue,https://help.expensify.com/articles/new-expensify/billing-and-subscriptions/manage-your-subscription-and-billing/manage-billing/resolve-billing-issues/Fix-a-Billing-Issue

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Redirect billing issue URLs to existing articles

These redirects point migrated billing-issue articles under manage-billing/resolve-billing-issues/, but this commit does not add any articles in that directory; Fix-a-Billing-Issue.md exists one level higher under manage-billing, and Understand-Why-Billing-Issues-Occur.md is absent. Users following the old billing issue URLs will therefore be redirected to 404s instead of the new content.

Useful? React with 👍 / 👎.

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR re-lands the billing-and-subscriptions hub reorganization (from the reverted #95101) plus lint-safe route-helper changes in createDocsRoutes.ts. The documentation portion adds 15 new articles organized into explore-plans-subscriptions-and-pricing and manage-your-subscription-and-billing (with manage-billing and manage-subscription subfolders), along with _meta.yml ordering files and hub/LHN template updates. The content is high quality overall: well-structured, task-focused, and consistently formatted. The main gaps are a few broken relative cross-links and inconsistent capitalization of key terms.

Scores Summary

  • Readability: 9/10 - Clear, scannable prose with strong use of numbered steps, tables, and concise benefit-focused intros. Steps are sequential and action-oriented.
  • AI Readiness: 8/10 - Complete YAML metadata (title, description, keywords, internalScope) on every article, correct heading hierarchy using only # and ##, and at least one full "How to..." heading per article using exact feature names. A few ## headings are topic-style rather than task-based (see below).
  • Style Compliance: 7/10 - Exact UI labels are bolded correctly, the three dots convention is followed, and the unified navigation phrasing is used well. Points lost for inconsistent capitalization of "Workspace"/"workspace" and "Workspace Admin"/"admin", and for broken relative cross-links.

Key Findings

  • Strengths: Every article has full YAML metadata including internalScope; single-workflow scoping is respected; FAQ sections follow the naming conventions; navigation uses the approved "in the navigation tabs (on the left on web, on the bottom on mobile)" pattern; button/tab/section names are bolded in Sentence case; the three dots convention is applied correctly in Add-or-Update-a-Payment-Card.md.
  • Broken/incorrect cross-links (must fix):
    • Cancel-an-Annual-Subscription.md links to a path beginning with docs/articles/new-expensify/...Learn-About-Plan-and-Subscription-Management. It starts with docs/ instead of a leading slash, so the relative link will not resolve.
    • Compare-Collect-and-Control-Plans.md FAQ links to a folder named explore-plans-and-subscriptions/Understand-Expensify-Pricing, but the actual folder is explore-plans-subscriptions-and-pricing. Likely a 404.
    • Learn-About-Subscriptions.md "Related articles" links to explore-plans-subscriptions-and-pricing/Learn-About-Plan-and-Subscription-Management, but that article lives under manage-your-subscription-and-billing/manage-subscription/.
  • Capitalization consistency (Style): "Workspace" is frequently lowercased ("workspace", "workspaces") and "Workspace Admin"/"Workspace owner" appears as "workspace Owner"/"admin" in places (e.g. Add-or-Update-a-Payment-Card.md, Cancel-an-Annual-Subscription.md). Per the naming conventions, use the exact product term consistently.
  • Heading task-based rules (AI Readiness): a few ## headings read as topic labels rather than actions/questions, e.g. "Common feature differences between Collect and Control" and "What subscriptions are available". These are borderline; prefer clear action/question phrasing.
  • External URLs: Understand-Expensify-Pricing.md and Compare-Collect-and-Control-Plans.md use full expensify.com/pricing URLs. The authoring guidelines say use relative links only; linking to the marketing pricing page is reasonable, but confirm this is intentional.

Recommendations

  • Priority: Fix the three broken relative cross-links above (leading slash + correct folder paths) before merge, since the reorg changes paths and dead links hurt both users and AI retrieval.
  • Priority: Standardize capitalization of "Workspace", "Workspace Admin", and "Workspace owner" across all new articles.
  • Suggestion: Tighten the few topic-style ## headings into task/question form to fully satisfy the heading rules.
  • Suggestion: Verify _meta.yml order values and article order frontmatter render the intended hub/LHN sequence after running createDocsRoutes.

Files Reviewed

  • explore-plans-subscriptions-and-pricing/Compare-Collect-and-Control-Plans.md - Good; fix FAQ cross-link path.
  • explore-plans-subscriptions-and-pricing/Learn-About-Subscriptions.md - Good; fix Related-articles cross-link path.
  • explore-plans-subscriptions-and-pricing/Understand-Expensify-Pricing.md - Strong (currency selector, clear tables); confirm external pricing URL is intentional.
  • manage-billing/Add-or-Update-a-Payment-Card.md - Strong; three dots rule applied; fix "workspace Owner" casing.
  • manage-billing/Find-Your-Expensify-Billing-Receipt.md - Good.
  • manage-billing/Fix-a-Billing-Issue.md - Strong; clear message/action table.
  • manage-billing/Request-Tax-Exemption.md - Good.
  • manage-billing/Review-Your-Expensify-Billing-Receipt.md - Strong; task-based section headings throughout.
  • manage-billing/Transfer-Workspace-Ownership.md - Strong; thorough FAQ.
  • manage-subscription/Cancel-an-Annual-Subscription.md - Good; fix docs-prefixed cross-link; standardize "workspace" casing.
  • manage-subscription/Change-Your-Workspace-Plan.md - Good.
  • manage-subscription/Learn-About-Plan-and-Subscription-Management.md - Strong.
  • manage-subscription/Manage-Annual-Subscription-Settings.md - Strong; clear settings explanations.
  • manage-subscription/View-Your-Plan-and-Subscription.md - Good.
  • _meta.yml (x4) + hub/LHN/section templates + createDocsRoutes.ts + redirects.csv - Structural/routing changes supporting the reorg; not scored as article content.

Note: This is a top-level summary. Verify the flagged cross-links and capitalization inline where noted.

Avoid spellcheck failure on the nested LHN section loop variable name.

Co-authored-by: Cursor <cursoragent@cursor.com>
@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@OSBotify

This comment has been minimized.

@OSBotify

Copy link
Copy Markdown
Contributor

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

Updated articles:

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants