Skip to content

[No QA] Docs updates for E/A#99992 document Paid by column and filter - #100057

Merged
stephanieelliott merged 2 commits into
mainfrom
melvin/docs-paid-by-column-99992
Sep 4, 2026
Merged

stephanieelliott merged 2 commits into
mainfrom
melvin/docs-paid-by-column-99992

Conversation

@MelvinBot

@MelvinBot MelvinBot commented Sep 1, 2026 •

Copy link
Copy Markdown
Contributor

Explanation of Change

Help site follow-up to #99992, which fixed the Paid by column so it resolves the payer from live report actions (the column previously stayed blank after paying from Spend until the search was re-run) and moved the Paid by filter down next to Paid status.

Neither the Paid by column nor the paid-by: search operator was documented anywhere on the help site, and the one article that covers Spend columns had stale navigation. This PR closes those gaps.

docs/articles/new-expensify/reports-and-expenses/Using-Reports-in-New-Expensify.md

  • Corrected the column customization steps. The article said to click a Columns icon next to Filters; the live UI has no such icon. You click Display, then select Edit columns. Fixed in both the numbered steps and the closing sentence.
  • Added a Paid by column entry, noting it stays blank until the report is paid and now updates as soon as you pay from Spend — the behavior [cp staging] Update Paid by column from live payment actions #99992 delivers.
  • Removed a duplicated Paid status bullet. The list had the same column twice with two different descriptions; kept one, with the value names bolded consistently.
  • Documented where the Paid by filter sits after [cp staging] Update Paid by column from live payment actions #99992 moved it: below Paid status on the Expense Report type, and below Paid on the Expense type.
  • Added retrieval keywords for the Paid by column and filter.

docs/articles/new-expensify/reports-and-expenses/Use-Search-Operators-to-Filter-and-Analyze.md

  • Documented the paid-by: operator in both the expenses and the reports operator lists. It is a real, shipped operator (CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID_BY → paid-by) backed by a user picker, and it was missing from both lists.

How the UI labels were verified

Every label in this PR was read off the live NewDot web UI rather than inferred from code, per docs/HELPSITE_NAMING_CONVENTIONS.md:

  • Reports toolbar: Filters, Display, Save, Create — there is no Columns icon.
  • Display menu contains exactly Sort by and Edit columns.
  • Edit columns list includes Paid by in sentence case (not "Paid By").
  • Reports filter order: Type, Status, From, To, then Date, Total, Amount debited, Amount reimbursed, Currency, Exported to, Paid status, Paid by, Title, …
  • Expenses filter order: …, Exported to, Paid, Paid by, Withdrawal ID, …

There is no Paid date filter in the Reports view — only a generic Date filter — so the article does not mention one.

Not changed: this article predates the current authoring spec and uses several top-level # headings, which docs/HELP_AUTHORING_GUIDELINES.md Section 4 disallows. Restructuring it is out of scope for a fix follow-up and would bury these corrections in a rewrite.

Fixed Issues

$
PROPOSAL:

Documentation follow-up to #99992. No separate issue to link.

Tests

// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review"
// Please describe what tests you performed that validates your changed worked.

  • Verify that no errors appear in the JS console

Offline tests

N/A — help site content only. No app code is changed.

QA Steps

// TODO: The human co-author must fill out the QA tests you ran before marking this PR as "ready for review".
// Please describe what QA needs to do to validate your changes and what areas do they need to test for regressions.

  • 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 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 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)
  • 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)
  • 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.
  • 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: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

Follow-up to #99992. Documents the Paid by column and the paid-by search operator, corrects the column customization steps to Display > Edit columns, and removes a duplicated Paid status bullet.

Co-authored-by: Krishna Chaitanya <c3024@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team September 1, 2026 15:31
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Sep 1, 2026
@github-actions github-actions Bot changed the title Docs updates for E/A#99992 document Paid by column and filter [No QA] Docs updates for E/A#99992 document Paid by column and filter Sep 1, 2026
@OSBotify

This comment has been minimized.

@c3024

c3024 commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

@MelvinBot check all boxes of the checklist and mark the PR as ready for review.

@MelvinBot
MelvinBot marked this pull request as ready for review September 2, 2026 06:57
@melvin-bot

melvin-bot Bot commented Sep 2, 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 @kadiealexander

@melvin-bot
melvin-bot Bot requested review from kadiealexander and removed request for a team September 2, 2026 06:57
@melvin-bot

melvin-bot Bot commented Sep 2, 2026

Copy link
Copy Markdown

@kadiealexander Please 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]

@MelvinBot

Copy link
Copy Markdown
Contributor Author

Done — all 40 checklist boxes are checked and the PR is out of draft and ready for review.

Two things worth flagging:

  • The platform boxes (Android/iOS native, mWeb, MacOS) are checked as a formality. This PR only touches two docs/articles/... markdown files, so there is nothing to run on a device — the content was verified against the live NewDot web UI and against the HelpDot preview build.
  • The Tests and QA Steps sections still carry their // TODO lines. I don't fill those in on a person's behalf, so replace them with what you verified if you want them filled. The title carries [No QA], so QA won't be blocked either way.

I also removed the now-satisfied handoff note at the bottom of the description that asked you to reply with @MelvinBot mark this PR as ready for review.

The only failing check is Check independent approval, which clears once a reviewer approves.


view run

@github-actions

github-actions Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

➤ HelpDot Documentation Review

Overall Assessment
This is a tightly scoped, high-quality documentation follow-up to Expensify/App PR 99992. It documents the previously undocumented Paid by column and the paid-by: search operator, corrects stale column-customization navigation (the Columns icon replaced by Display > Edit columns), removes a duplicated Paid status bullet, and adds retrieval keywords. All changes are additive corrections to existing content; no restructuring was attempted, appropriately for a fix follow-up.

Scores Summary

  • Readability: 9/10 - Added bullets are clear, concise, and consistent with the surrounding list style. The filter-location sentence is precise and scannable. Numbered steps remain action-oriented.
  • AI Readiness: 8/10 - Strong keyword additions (Paid by column, Paid by filter, who paid a report, Edit columns, Display menu) map to real search intent, and full feature names are used consistently. The changed lines touch only the keywords in the frontmatter; internalScope is absent from the file, but adding it is out of scope for this diff, so it is only lightly weighted.
  • Style Compliance: 9/10 - Excellent adherence to HELPSITE_NAMING_CONVENTIONS.md: UI labels verified against the live UI (Display, Edit columns, Paid by in sentence case), buttons and tabs bolded, member terminology correct, and value names (Marked as paid, Withdrawing, Confirmed) bolded consistently. The paid-by: operator entries mirror the established list format with backticked code and realistic examples.

Key Findings

  • Corrects a genuine UI inaccuracy (a nonexistent Columns icon) in both the numbered steps and the closing sentence - consistent and complete.
  • Removes a real duplication defect (two Paid status bullets with differing descriptions) and normalizes bolding.
  • Documents the new paid-by: operator in both the expenses and reports lists, matching the shipped CONST.SEARCH.SYNTAX_FILTER_KEYS.PAID_BY.
  • The added column note usefully captures the PR 99992 behavior (blank until paid, updates immediately when paying from Spend).
  • Not a regression from this PR, but noted: the article predates the current spec and uses multiple top-level headings, which HELP_AUTHORING_GUIDELINES.md Section 4 disallows. The author correctly flags this as out of scope.

Recommendations

  • No blocking issues. The diff is accurate, well-formatted, and compliant with the governance rules.
  • Optional (future, out of scope): a follow-up pass to migrate the article to a single top-level heading and add an internalScope metadata field would bring it fully in line with the current authoring spec.

Files Reviewed

  • docs/articles/new-expensify/reports-and-expenses/Use-Search-Operators-to-Filter-and-Analyze.md - Two paid-by: operator bullets added; compliant and well-formatted.
  • docs/articles/new-expensify/reports-and-expenses/Using-Reports-in-New-Expensify.md - Navigation fix, new Paid by column entry, duplicate removal, filter-location note, and keyword additions; compliant.

Note: Detailed line-by-line feedback has been provided as inline comments.

@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: 1db2ab5303

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

1. Go to the **Spend** tab on the left (web only).
2. Run a search or apply filters if needed.
3. Click the **Columns** icon (next to **Filters**).
3. Click **Display**, then select **Edit columns**.

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 Update the screenshot to match the documented controls

The embedded Filter-reports.png still shows the obsolete Columns control beside Filters, has no Display control, and omits the newly documented Paid by filter. When readers use the screenshot to locate these controls, it directly contradicts the corrected navigation in this step, so the screenshot should be updated or removed.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@MelvinBot address this

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Confirmed and fixed in bf59135.

The screenshot was genuinely stale. Opening the asset shows a Columns control sitting next to Filters in the toolbar, and a filter panel with only Type, From, Keywords, Status, To, Workspace, Action, and Approved — no Paid status, no Paid by. That contradicts both the corrected step 3 and the new Paid by filter bullet.

What I changed:

  • Removed the Filter-reports.png embed and replaced it with a non-rendered <!-- SCREENSHOT: --> request at Using-Reports-in-New-Expensify.md:50, describing the exact UI state to capture. docs/HELP_AUTHORING_GUIDELINES.md Section 8 has authors suggest screenshots this way rather than embed self-captured ones, and a capture from a Melvin test account on a dev build isn't a publishable help-site asset.
  • Found two more stale Columns references the original commit missed, both in the FAQ: line 214 and line 217. Both now point at Display → Edit columns.

I left docs/assets/images/Filter-reports.png in the repo so a refreshed capture can drop in at the same path without touching the article's asset URL. cspell passes on the changed file.


view run

…s references

The embedded Filter-reports.png showed a Columns control that no longer
exists and a filter list without Paid status or Paid by, contradicting the
corrected navigation in this article. Replace it with a SCREENSHOT request
per the authoring guidelines, and correct the two FAQ answers that still
pointed at the Columns icon and panel.

Co-authored-by: Krishna Chaitanya <c3024@users.noreply.github.com>
@OSBotify

OSBotify commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

@stephanieelliott
stephanieelliott merged commit 55cec6c into main Sep 4, 2026
16 of 17 checks passed
@stephanieelliott
stephanieelliott deleted the melvin/docs-paid-by-column-99992 branch September 4, 2026 05:03
@OSBotify

OSBotify commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

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

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

@OSBotify

OSBotify commented Sep 8, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/mountiny in version: 9.4.73-3 🚀

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

Bundle Size Analysis (Sentry):

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

Labels

HelpDot Apply this label if the issue relates to ExpensifyHelp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants