Skip to content

[No QA] [NO QA] Docs updates for E/A#87740 Update attendee column docs for optional sorting#88408

Merged
stephanieelliott merged 1 commit into
mainfrom
melvinbot-docs-update-87740
May 9, 2026
Merged

[No QA] [NO QA] Docs updates for E/A#87740 Update attendee column docs for optional sorting#88408
stephanieelliott merged 1 commit into
mainfrom
melvinbot-docs-update-87740

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary

  • Updates Adding-Attendees.md to reflect that Attendees and Per attendee columns are no longer auto-shown in search results — users must enable them via the Columns picker
  • Adds documentation that these columns now support sorting
  • Updates Managing-Expenses-in-a-Report.md to clarify attendee columns are optional via the Columns picker

Related PR: #87740

Attendees and Per attendee columns are now optional in search results
and can be enabled via the Columns picker. Once enabled, they support
sorting. Updates Adding-Attendees.md and Managing-Expenses-in-a-Report.md
to reflect this behavior change from E/A#87740.

Co-authored-by: nkdengineer <nkdengineer@users.noreply.github.com>
@github-actions github-actions Bot changed the title [NO QA] Docs updates for E/A#87740 Update attendee column docs for optional sorting [No QA] [NO QA] Docs updates for E/A#87740 Update attendee column docs for optional sorting Apr 21, 2026
@OSBotify
Copy link
Copy Markdown
Contributor

@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label May 6, 2026
@stephanieelliott stephanieelliott self-assigned this May 6, 2026
@stephanieelliott stephanieelliott marked this pull request as ready for review May 9, 2026 02:56
@stephanieelliott stephanieelliott self-requested a review as a code owner May 9, 2026 02:56
@stephanieelliott stephanieelliott merged commit 8405c32 into main May 9, 2026
23 of 25 checks passed
@stephanieelliott stephanieelliott deleted the melvinbot-docs-update-87740 branch May 9, 2026 02:56
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 9, 2026

@stephanieelliott looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@melvin-bot melvin-bot Bot added the Emergency label May 9, 2026
- Workspace violations (if applicable)

Additional columns such as **Attendees** and **Per attendee** can be enabled via the **Columns** picker when attendee tracking is available.

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.

Naming / UI terminology: "Columns picker" adds the word "picker" which may not match the exact UI label. Per HELPSITE_NAMING_CONVENTIONS.md, use the exact text shown in the product UI — do not add extra words. If the UI button is simply Columns, write "via the Columns button" or "by clicking Columns" instead of "via the Columns picker."

Also, "when attendee tracking is available" is vague — consider stating the specific condition (e.g., "when at least one expense in the report has attendees") for deterministic clarity.

- **Per attendee:** shows the total amount divided equally among all attendees.

These columns appear in both the report and search results.
In search results (**Reports > Expenses**), these columns are not shown by default. To enable them:
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.

Step formatting: This paragraph mixes an explanation with procedural steps (lines 51-53). Per HELP_AUTHORING_GUIDELINES.md Section 5, step instructions should be sequential and action-oriented. Consider starting the numbered steps from a clearer entry point — right now the instruction "Go to Reports > Expenses" in step 1 duplicates the path already mentioned in this sentence. You could remove the redundant path reference here or remove step 1 below.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 9, 2026

HelpDot Documentation Review

Overall Assessment

This PR updates two articles to reflect changes in how attendee columns are displayed in reports and search results. The changes are focused and well-scoped: metadata is updated to match new content, a previously incorrect # heading is corrected to ##, and new procedural steps are added for enabling attendee columns. The Managing-Expenses article receives a lighter touch, replacing a static column list with a reference to the Columns picker.

Scores Summary

  • Readability: 9/10 - The new steps are clear, sequential, and action-oriented. The instructions for enabling columns are concise and easy to follow. Minor note: the sentence "Once enabled, you can click the column header to sort expenses by that column" is clear but slightly passive in construction.
  • AI Readiness: 9/10 - Metadata updates are well done: description and keywords now reflect the new column/sort content, and internalScope is updated accordingly. The heading "How to view attendees on a report" is task-based and includes the feature name. The article retains at least one "How to..." heading as required.
  • Style Compliance: 9/10 - UI elements (Columns, Attendees, Per attendee amount, Reports > Expenses) are bolded correctly. The heading level fix from # to ## resolves a governance violation (only one # heading allowed per article, plus optional # FAQ). One minor observation: in Managing-Expenses, the phrase "via the Columns picker" uses "via" which is slightly informal -- "using the Columns picker" would be more consistent with the direct, action-oriented tone in the authoring guidelines, but this is not a blocking issue.

Key Findings

  • Heading fix (positive): The change from # How to view attendees on a report to ## How to view attendees on a report in Adding-Attendees.md corrects a structural violation. Per Section 4 of the authoring guidelines, only one # heading (the article title) is allowed, plus the optional # FAQ.
  • Metadata alignment (positive): Both the description and keywords in Adding-Attendees.md are updated to reflect the new column visibility and sorting content, which improves search retrieval accuracy.
  • Consistent cross-file updates (positive): Both articles are updated in tandem -- Managing-Expenses removes the static attendee column listing and points to the Columns picker, while Adding-Attendees provides the detailed how-to. This avoids duplication and keeps each article focused on a single workflow.
  • No cross-linking between the two articles: Since Managing-Expenses now references the Columns picker for attendee columns, consider whether a cross-link to the Adding-Attendees article would help readers who want the full procedural steps. Per the cross-linking standards, this would qualify as a "deep-dive explanation" scenario. This is a suggestion, not a requirement.

Recommendations

  1. Consider a cross-link from Managing-Expenses to Adding-Attendees for users who want detailed steps on enabling and using attendee columns.
  2. Minor wording tweak in Managing-Expenses: "can be enabled via the Columns picker" could read "can be enabled using the Columns picker" for a slightly more direct tone.

Files Reviewed

  • Adding-Attendees.md - Metadata updated, heading level corrected from # to ##, new procedural steps added for enabling columns in search results. All changes comply with governance rules.
  • Managing-Expenses-in-a-Report.md - Static attendee column entries removed from list, replaced with a reference to the Columns picker. Clean and well-scoped change.


1. Go to **Reports > Expenses**.
2. Click **Columns**.
3. Select **Attendees** and **Per attendee amount**.
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.

UI terminology: Verify that Per attendee amount is the exact label shown in the Columns menu. The rest of the article (lines 47, 97 of the other file) refers to it as Per attendee (without "amount"). If the UI label is "Per attendee," use that consistently. If the Columns menu label differs, note the distinction. Per HELPSITE_NAMING_CONVENTIONS.md: "Use the exact text shown in the product UI."

@OSBotify
Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@OSBotify
Copy link
Copy Markdown
Contributor

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

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

Bundle Size Analysis (Sentry):

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/lakchote in version: 9.3.72-1 🚀

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

HelpDot Apply this label if the issue relates to ExpensifyHelp

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants