Skip to content

[No QA] docs: add Print button to help site articles#86387

Merged
stephanieelliott merged 4 commits intomainfrom
claude-addPrintButtonHelpDocs
Apr 1, 2026
Merged

[No QA] docs: add Print button to help site articles#86387
stephanieelliott merged 4 commits intomainfrom
claude-addPrintButtonHelpDocs

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Explanation of Change

Updates help site documentation to reflect the new Print button added to expense reports in PR #84165. Three articles are updated:

  • Expense-and-Report-Actions.md: Added Print to the secondary actions table
  • Understanding-Report-Statuses-and-Actions.md: Added Print to the More button options list and invoice receiver actions
  • Search-and-Download-Expenses.md: Added a "How to print a report" section, a FAQ distinguishing Print from Download as PDF, and updated metadata keywords

Fixed Issues

$ #80625

Tests

  • Verify that no errors appear in the JS console
  1. Run the docs site locally and confirm the three updated articles render correctly
  2. Verify the Print action appears in the secondary actions table in Expense-and-Report-Actions.md
  3. Verify Print appears in the More button list in Understanding-Report-Statuses-and-Actions.md
  4. Verify the new "How to print a report" section and FAQ render correctly in Search-and-Download-Expenses.md

Offline tests

N/A - documentation-only changes

QA Steps

  1. Navigate to the help site articles and verify Print is documented correctly in all three updated files
  2. Verify no formatting issues in the rendered markdown
  • 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

N/A - documentation-only changes

Add documentation for the new Print button feature (from PR #84165)
to the relevant help site articles:
- Expense-and-Report-Actions.md: Add Print to secondary actions table
- Understanding-Report-Statuses-and-Actions.md: Add Print to More menu list
- Search-and-Download-Expenses.md: Add Print section and FAQ entry

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot MelvinBot requested a review from a team March 26, 2026 03:33
@github-actions github-actions bot changed the title docs: add Print button to help site articles [No QA] docs: add Print button to help site articles Mar 26, 2026
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Mar 26, 2026

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

Updated articles:

@stephanieelliott
Copy link
Copy Markdown
Contributor

@MelvinBot undo the changes to the file search-and-Download-Expenses.md, those changes are not relevant.

Co-authored-by: stephanieelliott <78835559+stephanieelliott@users.noreply.github.com>
Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

Reverted all changes to Search-and-Download-Expenses.md as requested — the file is now back to its main branch state.

@stephanieelliott stephanieelliott marked this pull request as ready for review March 26, 2026 03:56
@stephanieelliott stephanieelliott self-requested a review as a code owner March 26, 2026 03:56
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Mar 26, 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 @lschurr

@melvin-bot melvin-bot bot requested review from lschurr and sobitneupane and removed request for a team March 26, 2026 03:56
@melvin-bot
Copy link
Copy Markdown

melvin-bot bot commented Mar 26, 2026

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

@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds documentation for a new Print button across two existing help articles. The changes are minimal, well-scoped, and consistent with the surrounding content in both files. The additions correctly document the feature's availability, visibility, and behavior.

Scores Summary

  • Readability: 9/10 - The new content is clear, concise, and follows the established patterns in both articles. The table row in Expense-and-Report-Actions.md is well-structured with appropriate column values. The list addition and inline mention in Understanding-Report-Statuses-and-Actions.md read naturally.
  • AI Readiness: 9/10 - No changes to headings, metadata, or article structure. The additions are purely content within existing well-structured sections, so there is nothing new to evaluate for heading hierarchy or YAML metadata. The feature name "Print" is explicit and searchable.
  • Style Compliance: 8/10 - Button name formatting is mostly correct. Print is properly bolded in the table and in the inline invoice receiver reference. One minor inconsistency: in the More button options list (line 37 of Understanding-Report-Statuses-and-Actions.md), "Print" appears unbolded as a plain list item, while the same feature appears bolded as Print in the inline reference later in the same file. This matches the existing convention in that specific list (where other items like "Hold / Unhold" and "Unapprove" are also unbolded), so it is internally consistent within each section, but worth noting.

Key Findings

  • The table row description in Expense-and-Report-Actions.md states "triggers the browser's print dialog," which is web-specific language. If the Print action is also available on mobile (iOS/Android), this description may be incomplete or misleading. Per HELPSITE_NAMING_CONVENTIONS.md cross-platform clarity rules, platform-specific behavior should be explicitly called out rather than implied as universal.
  • The placement of Print next to Download in the table is logical since both are output/export-related actions -- good editorial judgment.
  • The Oxford comma usage in "Download, Print, and View Details" is correct and reads cleanly.
  • The existing article content (not part of this diff) uses "More" to reference the menu button, which conflicts with the three dots menu rule in HELPSITE_NAMING_CONVENTIONS.md. This is not something to address in this PR, but is worth noting for future cleanup.

Recommendations

  1. Consider cross-platform language: If Print is available on mobile, revise the Expense-and-Report-Actions.md description from "triggers the browser's print dialog" to something platform-neutral, such as "Opens the report in a printable format" (dropping the browser-specific reference). If it is truly web-only, consider adding a note like "Web only" in the "When It Appears" column.
  2. No other changes are needed -- the additions are clean and well-integrated.

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Expense-and-Report-Actions.md - One table row added for Print action. Well-formatted and consistent with existing rows.
  • docs/articles/new-expensify/reports-and-expenses/Understanding-Report-Statuses-and-Actions.md - Two changes: Print added to the More button options list, and Print inserted into the invoice receiver actions sentence. Both are clean additions.

stephanieelliott and others added 2 commits March 25, 2026 17:59
…-Report-Statuses-and-Actions.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
…-Report-Statuses-and-Actions.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@lschurr lschurr left a comment

Choose a reason for hiding this comment

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

LGTM!

@stephanieelliott stephanieelliott merged commit f938541 into main Apr 1, 2026
13 checks passed
@stephanieelliott stephanieelliott deleted the claude-addPrintButtonHelpDocs branch April 1, 2026 04:08
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 2, 2026

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

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

Bundle Size Analysis (Sentry):

@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented Apr 7, 2026

🚀 Deployed to production by https://github.com/roryabraham in version: 9.3.52-9 🚀

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants