Skip to content

[No QA] Update article and rename TravelPerk.md to Perk.md#84223

Open
stephanieelliott wants to merge 4 commits intomainfrom
helpsite-rename-perk
Open

[No QA] Update article and rename TravelPerk.md to Perk.md#84223
stephanieelliott wants to merge 4 commits intomainfrom
helpsite-rename-perk

Conversation

@stephanieelliott
Copy link
Contributor

@stephanieelliott stephanieelliott self-assigned this Mar 5, 2026
@stephanieelliott stephanieelliott requested a review from a team as a code owner March 5, 2026 00:49
@melvin-bot
Copy link

melvin-bot bot commented Mar 5, 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 @CortneyOfstad

@melvin-bot melvin-bot bot requested review from CortneyOfstad and amyevans and removed request for a team March 5, 2026 00:49
@melvin-bot
Copy link

melvin-bot bot commented Mar 5, 2026

@amyevans @CortneyOfstad 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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 5, 2026

HelpDot Documentation Review

Overall Assessment

This PR renames TravelPerk.md to Perk.md to reflect the product rebranding, rewrites the article content, and adds a proper redirect. The new article is a significant improvement over the old one: it adopts an FAQ structure, uses task-based headings, and follows a clearer flow. However, there are several issues against the HelpDot authoring guidelines that should be addressed before merging.

Scores Summary

Dimension Score Notes
Readability 8/10 Clear, concise language at an appropriate reading level. Good logical flow from prerequisites to setup to how-it-works to FAQ. Minor punctuation issues.
AI Readiness 7/10 Good keywords and descriptive headings. Missing the required internalScope YAML field. Blank line after opening --- in frontmatter may cause parsing issues.
Style Compliance 7/10 Mostly compliant with Expensify voice. A few guideline deviations noted below (H1 repeats the title, missing period in FAQ answer).

Key Findings

Strengths

  • The rewrite is a clear improvement: the old article contained inaccurate setup steps (navigating to Settings > Workspaces > Accounting > TravelPerk) that do not reflect reality for this third-party integration. The new article correctly states the integration is managed in Perk.
  • Task-based ## headings ("How to set up the Perk integration with Expensify", "How Perk automatically creates expenses in Expensify") align well with the authoring guidelines and AI retrieval optimization.
  • The FAQ section is well-structured with searchable, question-based headings.
  • Proper redirect added in redirects.csv to avoid broken links.
  • Keywords are comprehensive and include the old product name ("Travel Perk") for discoverability.

Issues Found

Medium Severity

  1. Missing internalScope in YAML metadata -- Per HELP_AUTHORING_GUIDELINES.md, Section 3, every article must include internalScope in the format: "Audience is [target role]. Covers [main topic]. Does not cover [excluded areas]." This field is absent from the frontmatter.

  2. Blank line after opening --- in frontmatter -- Line 2 of the new file is blank (between --- and title:). This could cause YAML parsing issues with Jekyll. The frontmatter should have no blank lines between the opening --- and the first field.

  3. Duplicate H1 heading -- The article has a "# Connecting Perk to Expensify" heading (line 13) that duplicates the YAML title field. Since Jekyll uses the YAML title as the page H1, having a second H1 with the same text creates redundancy. The authoring guidelines state only one primary # heading should be used, and the # FAQ section already serves as a second H1. Consider whether the first H1 is needed or if the content under it should use ## headings directly.

  4. Two H1 headings used -- The article uses both "# Connecting Perk to Expensify" and "# FAQ". The authoring guidelines allow # FAQ as a standard pattern, but having two non-FAQ H1 headings in a single article may cause issues with heading hierarchy expectations. The guidelines state "Only # and ## used" -- this is satisfied, but the structure would be cleaner with a single primary H1.

Low Severity

  1. Missing period in FAQ answer -- Line 59: "This typically happens when the traveler does not have an Expensify account or the traveler's email address is different in Perk and Expensify" is missing a period at the end of the sentence.

  2. Trailing whitespace -- Lines 15 and 17 appear to have trailing whitespace after the heading text and sentence text respectively. While not functionally breaking, this is a minor cleanliness issue.

  3. External link may break -- The link to https://support.perk.com/hc/en-us/articles/21926013804188-Integrate-Expensify-with-Perk should be verified. If TravelPerk rebranded to Perk, their support URLs may have changed or may change. Consider confirming this URL resolves correctly.

Recommendations

  1. Add internalScope to the YAML frontmatter, e.g.: "Audience is Workspace Admins and Perk Account Admins. Covers connecting Perk to Expensify for automated travel expense syncing. Does not cover Perk account setup, booking workflows, or Expensify report approval."
  2. Remove the blank line between the opening --- and the title: field in the YAML frontmatter.
  3. Consider restructuring so there is only one primary H1 (either the title or "# Connecting Perk to Expensify"), with all other non-FAQ sections as ## headings. The # FAQ section is an accepted convention and can remain as-is.
  4. Add the missing period at the end of the sentence on line 59.
  5. Verify the external Perk support link resolves correctly.

Files Reviewed

File Status
docs/articles/expensify-classic/connections/Perk.md New file (68 lines) -- Rewritten article with improved structure; needs minor metadata and formatting fixes
docs/articles/expensify-classic/connections/TravelPerk.md Deleted -- Properly removed as part of rename
docs/redirects.csv Updated -- Correct redirect from old TravelPerk URL to new Perk URL

Note: This review evaluates only the proposed changes in the diff, not unchanged content from the repository.

@github-actions github-actions bot changed the title Update article and rename TravelPerk.md to Perk.md [No QA] Update article and rename TravelPerk.md to Perk.md Mar 5, 2026
@OSBotify
Copy link
Contributor

OSBotify commented Mar 5, 2026

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

Updated articles:

stephanieelliott and others added 2 commits March 4, 2026 17:21
Apply reviewer bot comments

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Add internalScope
@stephanieelliott stephanieelliott removed the request for review from amyevans March 5, 2026 03:22
Comment on lines +57 to +58

This typically happens when the traveler does not have an Expensify account or the traveler's email address is different in Perk and Expensify
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
This typically happens when the traveler does not have an Expensify account or the traveler's email address is different in Perk and Expensify

Duplicate of the line above

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.

3 participants