Skip to content

[No QA] Refractor new-expensify/connect-credit-cards#87276

Open
stephanieelliott wants to merge 34 commits intomainfrom
helpsite-universal-feed-updates
Open

[No QA] Refractor new-expensify/connect-credit-cards#87276
stephanieelliott wants to merge 34 commits intomainfrom
helpsite-universal-feed-updates

Conversation

@stephanieelliott
Copy link
Copy Markdown
Contributor

@stephanieelliott stephanieelliott commented Apr 7, 2026

Re-scoping and adding additional articles to improve coverage

Will add peripheral articles and images in a separate PR

@stephanieelliott stephanieelliott self-assigned this Apr 7, 2026
…up-a-Direct -Company-Card-Feed-Connection.md
…hare-a-Company-Card-Connection-Across-Workspaces.md
… Set-up-a-Direct-Company-Card-Feed-Connection.md
@stephanieelliott stephanieelliott marked this pull request as ready for review April 8, 2026 02:23
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 8, 2026

HelpDot Documentation Review

Overall Assessment

This PR restructures the connect-credit-cards section by splitting monolithic articles (Commercial-feeds.md, Direct-feeds.md, Assign-and-Manage-Cards.md) into focused, single-workflow articles. This is a strong architectural improvement aligned with the one-workflow-per-article principle. However, several critical issues — a broken filename, incorrect cross-link paths, broken step numbering, and formatting errors — must be resolved before merge.

Scores Summary

  • Readability: 7/10 - Generally clear, scannable steps with good structure. Deducted for duplicate words ("submitted submitted"), broken step numbering ("5. 3."), a typo ("Mastercar"), grammar error ("a American Express"), and broken bold formatting ("**What it means: **").
  • AI Readiness: 8/10 - All new articles include proper YAML frontmatter with internalScope, task-based headings, and "How to" sections. The filename with a leading space will break automated indexing and linking. Title/heading casing mismatch in Manage-Personal-Cards.md (title "Manage Personal Cards" vs heading "Manage personal cards") reduces retrieval consistency.
  • Style Compliance: 7/10 - Navigation instructions correctly follow the unified format. UI element bolding is mostly correct. Deducted for "More Features" (should be "More features" per sentence case), broken cross-links pointing to wrong paths, and the markdown separator typo ("--" instead of "---").

Key Findings

Critical (must fix before merge):

  1. Leading space in filename: Configure-Company-Card-Settings.md has a leading space in its name ( Configure-Company-Card-Settings.md). This will break links, builds, and automated tooling.

  2. Broken cross-links to wrong path: In Assign-Company-Cards.md and Share-a-Company-Card-Connection-Across-Workspaces.md, links point to /articles/new-expensify/billing-and-subscriptions/Set-up-a-Direct-Company-Card-Feed-Connection and /articles/new-expensify/billing-and-subscriptions/Set-up-a-Commercial-Card-Feed-Connection. These should be under connect-credit-cards/, not billing-and-subscriptions/. This affects four links across two files.

  3. Broken link target: Set-up-a-Direct-Company-Card-Feed-Connection.md links to /articles/new-expensify/connect-credit-cards/How-to-assign-company-cards, which does not exist. It should link to Assign-Company-Cards.

  4. Missing leading slash: In Set-up-a-Commercial-Card-Feed-Connection.md FAQ, the link (articles/new-expensify/connect-credit-cards/Set-up-a-Direct-Company-Card-Feed-connection) is missing its leading / and has incorrect casing ("connection" vs "Connection").

  5. Broken step numbering: In Set-up-a-Commercial-Card-Feed-Connection.md (Amex section), step 5 reads "5. 3. In Expensify..." — a leftover from the old article that corrupts the numbered list.

Important (should fix):

  1. Duplicate word: Assign-Company-Cards.md — "submitted submitted" in the "What happens after" section.

  2. Typo in YAML: Set-up-a-Commercial-Card-Feed-Connection.md description reads "Mastercar" (missing "d").

  3. Grammar: Set-up-a-Commercial-Card-Feed-Connection.md — "a American Express" should be "an American Express".

  4. Broken bold formatting: Fix-a-Broken-Company-Card-Feed-Connection.md — "**What it means: **" has a space before the closing asterisks, which will render incorrectly.

  5. Markdown separator: Set-up-a-Direct-Company-Card-Feed-Connection.md uses -- instead of --- for one horizontal rule, which will not render as a separator.

  6. Title/heading mismatch: Manage-Personal-Cards.md title is "Manage Personal Cards" but the H1 heading is "Manage personal cards" — these should match per governance rules.

  7. UI casing: Share-a-Company-Card-Connection-Across-Workspaces.md references "More Features" — should be "More features" to match sentence case UI convention. (Also appears in Set-up-a-Commercial-Card-Feed-Connection.md as "More features" which is correct — so this is inconsistent across the PR.)

Positive aspects:

  • The split from monolithic articles into single-workflow articles is well-executed and follows governance principles.
  • All new articles include complete YAML frontmatter with internalScope metadata.
  • Task-based headings are well-crafted throughout (e.g., "How to fix a broken company card connection", "How to set up a direct company card feed connection").
  • Navigation instructions consistently use the correct unified format: "Click the navigation tabs (on the left on web, on the bottom on mobile)".
  • FAQ sections use proper question-format headings.
  • Cross-link anchor text is descriptive (e.g., "Learn how to set up a direct company card feed connection").
  • The troubleshooting article (Fix-a-Broken) provides structured error-specific guidance that is highly scannable.

Recommendations

  1. Priority 1: Fix the leading space in the Configure-Company-Card-Settings.md filename immediately — this is a build-breaking issue.
  2. Priority 2: Correct all four broken cross-links that point to billing-and-subscriptions/ instead of connect-credit-cards/, the broken How-to-assign-company-cards link, and the missing leading slash in the FAQ link.
  3. Priority 3: Fix the broken step numbering in the Amex commercial feed setup section.
  4. Priority 4: Address the text-level issues: duplicate word, typo, grammar, bold formatting, markdown separator, title/heading mismatch, and UI casing inconsistency.

Files Reviewed

  • Configure-Company-Card-Settings.md (renamed) - CRITICAL: leading space in filename; content changes are minor and acceptable
  • Assign-Company-Cards.md (new) - Good structure; has broken cross-links and duplicate word
  • Assign-and-Manage-Cards.md (deleted) - Appropriately removed and replaced by focused articles
  • Check-Supported-Banks.md - Minor title capitalization change, acceptable
  • Commercial-feeds.md (deleted) - Replaced by Set-up-a-Commercial-Card-Feed-Connection.md
  • Direct-feeds.md (deleted) - Replaced by Set-up-a-Direct-Company-Card-Feed-Connection.md
  • Fix-a-Broken-Company-Card-Feed-Connection.md (new) - Well-structured troubleshooting article; has broken bold formatting
  • Manage-Personal-Cards.md (renamed) - Title/heading casing mismatch
  • Set-up-a-Commercial-Card-Feed-Connection.md (new) - Has broken step numbering, typo, grammar error, broken link, and missing leading slash
  • Set-up-a-Direct-Company-Card-Feed-Connection.md (new) - Has broken link target and markdown separator issue
  • Share-a-Company-Card-Connection-Across-Workspaces.md (new) - Has broken cross-links and UI casing issue

Note: This review covers only the proposed changes in the PR diff, not unchanged content from existing files.

@stephanieelliott stephanieelliott requested a review from a team as a code owner April 8, 2026 06:03
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 8, 2026

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

@melvin-bot melvin-bot bot requested review from bfitzexpensify and youssef-lr and removed request for a team April 8, 2026 06:04
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Apr 8, 2026

@youssef-lr @bfitzexpensify 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]

NOTE: It looks like docs/redirects.csv was modified in this PR. Please see this SO for special instructions on how to review changes to that file.

@stephanieelliott stephanieelliott removed the request for review from youssef-lr April 8, 2026 06:04
@stephanieelliott
Copy link
Copy Markdown
Contributor Author

Applied all bot comments

@github-actions github-actions bot changed the title Refractor new-expensify/connect-credit-cards [No QA] Refractor new-expensify/connect-credit-cards Apr 8, 2026
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