Skip to content

[No QA] Docs updates for E/A#91552 Add Task badge documentation to help site#91656

Merged
lschurr merged 3 commits into
mainfrom
melvin-docs-task-action-badge
Jun 9, 2026
Merged

[No QA] Docs updates for E/A#91552 Add Task badge documentation to help site#91656
lschurr merged 3 commits into
mainfrom
melvin-docs-task-action-badge

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Summary

  • Updates the Assign a Task via Chat help article to document the new green Task action badge that appears in the left-hand navigation (LHN) when a user has an outstanding task assigned to them in a workspace chat.
  • This change corresponds to Expensify/App#91552, which added the Task badge alongside existing action badges (Submit, Approve, Pay, Fix).

Changes

  • docs/articles/new-expensify/chat/Assign-Tasks.md: Added a new section explaining how to identify chats with outstanding tasks via the green Task badge, and added task badge to keywords.

@aimane-chnaif, please review the files changed and confirm they reflect the current behavior. Then mark this PR Ready for review.

Add documentation for the new green Task badge that appears in the
left-hand navigation when a user has an outstanding task assigned
to them in a workspace chat.

Co-authored-by: Aimane Chnaif <aimane-chnaif@users.noreply.github.com>
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label May 25, 2026
@github-actions github-actions Bot changed the title Docs updates for E/A#91552 Add Task badge documentation to help site [No QA] Docs updates for E/A#91552 Add Task badge documentation to help site May 25, 2026
@OSBotify

This comment has been minimized.

@stephanieelliott
stephanieelliott marked this pull request as ready for review May 27, 2026 05:22
@stephanieelliott
stephanieelliott self-requested a review as a code owner May 27, 2026 05:22
Comment thread docs/articles/new-expensify/chat/Assign-Tasks.md
@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds a new keyword ("task badge") to the YAML frontmatter and appends a new section explaining how to identify chats with outstanding tasks via the Task badge in the LHN. The changes are well-structured and follow most governance rules, with one notable metadata gap.

Scores Summary

  • Readability: 9/10 - The new section is clear, scannable, and concise. The bullet points effectively communicate badge behavior. No procedural steps are needed here since this is informational, so the format is appropriate.
  • AI Readiness: 7/10 - The new heading "How to identify chats with outstanding tasks" is task-based and searchable, which is good. The added keyword "task badge" improves discoverability. However, the internalScope field remains missing from the YAML frontmatter. While this omission is pre-existing, the diff modifies the keywords line without adding the mandatory internalScope field, which is a missed opportunity to bring the metadata into compliance (per HELP_AUTHORING_GUIDELINES.md Section 3 and TEMPLATE.md).
  • Style Compliance: 9/10 - UI element references are properly bolded (Task, Submit, Approve, Pay, Fix). The "left-hand navigation (LHN)" phrasing matches the required convention exactly. Badge names appear to match UI terminology.

Key Findings

  • The new ## How to identify chats with outstanding tasks heading correctly starts with a question word ("How"), is task-based, and is feature-specific. This follows the heading rules well.
  • All UI element names (badge labels) are properly bolded per naming conventions.
  • The "left-hand navigation (LHN)" reference follows the exact format specified in HELPSITE_NAMING_CONVENTIONS.md.
  • The internalScope field is missing from YAML frontmatter. Per HELP_AUTHORING_GUIDELINES.md Section 3, this field is mandatory for every article. Since the diff already touches the frontmatter (adding a keyword), this would be the right time to add it.

Recommendations

  1. Add internalScope to YAML frontmatter - This is mandatory per governance rules. A suggested value: internalScope: Audience is all Members. Covers identifying chats with outstanding tasks via the Task badge, does not cover task creation workflows in detail.
  2. Consider whether "task badge" as a keyword is sufficient or if "green task badge" or "outstanding tasks badge" would better match real user search queries.

Files Reviewed

  • docs/articles/new-expensify/chat/Assign-Tasks.md - New keyword added to frontmatter and new section appended explaining the Task badge in LHN. Well-written with one metadata gap.

Review based on governance rules in docs/HELPSITE_NAMING_CONVENTIONS.md, docs/HELP_AUTHORING_GUIDELINES.md, and docs/TEMPLATE.md.

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@OSBotify

This comment has been minimized.

Comment thread docs/articles/new-expensify/chat/Assign-Tasks.md Outdated
Comment thread docs/articles/new-expensify/chat/Assign-Tasks.md
@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds documentation for the new green Task badge in the left-hand navigation, along with improved YAML metadata (internalScope and an additional keyword). The changes are small, well-scoped, and generally align with governance standards. A few minor items could be tightened up.

Scores Summary

  • Readability: 8/10 - The new section is clear and scannable. Bullet points effectively communicate badge behavior. The parenthetical "(LHN)" slightly disrupts flow for external readers unfamiliar with the abbreviation.
  • AI Readiness: 9/10 - The new ## How to identify chats with outstanding tasks heading is properly task-based and includes a "How to" phrase. The addition of internalScope and the task badge keyword strengthen metadata for retrieval.
  • Style Compliance: 8/10 - UI element names (Task, Submit, Approve, Pay, Fix) are correctly bolded. However, "left-hand navigation (LHN)" introduces internal shorthand; per Section 6 of the Authoring Guidelines, articles should "Avoid internal language." The term "LHN" is not user-facing UI terminology.

Key Findings

  • Positive: The internalScope addition is a valuable improvement -- it was missing from the original file and is now present per the metadata requirements in Section 3 of the Authoring Guidelines.
  • Positive: The new ## heading follows task-based heading rules correctly, starting with "How to."
  • Minor issue: The abbreviation "LHN" in the phrase "left-hand navigation (LHN)" is internal Expensify jargon. The parenthetical should be removed; "left-hand navigation" is sufficient and more accessible to end users.
  • Note (not scored): The pre-existing file has structural issues outside this diff (multiple # headings such as # Create a Task and # Edit a Task, which violate the single-#-heading rule in Section 4). These are not penalized here since they are not part of the proposed changes, but they are worth addressing in a follow-up.

Recommendations

  1. Remove "(LHN)" from the new section. Use "left-hand navigation" without the abbreviation to comply with the rule against internal language.
  2. Consider a follow-up PR to fix the pre-existing heading hierarchy (# Create a Task and # Edit a Task should be ## headings per Section 4 of the Authoring Guidelines).

Files Reviewed

  • docs/articles/new-expensify/chat/Assign-Tasks.md -- YAML metadata improved (internalScope added, keyword added); new section on Task badge added. Minor terminology fix recommended.

Review based on governance files: HELPSITE_NAMING_CONVENTIONS.md, HELP_AUTHORING_GUIDELINES.md, and TEMPLATE.md.

@OSBotify

OSBotify commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

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

Updated articles:

Comment thread docs/articles/new-expensify/chat/Assign-Tasks.md
Comment thread docs/articles/new-expensify/chat/Assign-Tasks.md
@github-actions

github-actions Bot commented Jun 1, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR makes three changes to Assign-Tasks.md: adds the task badge keyword, introduces the required internalScope metadata field, and appends a new section documenting the Task badge feature in workspace chats. The additions are generally well-structured, but there are a few governance compliance items worth addressing.

Scores Summary

  • Readability: 8/10 - The new section is clear, scannable, and concise. The bullet points communicate behavior effectively. Minor deduction: the emoji prefix on the existing Note line (visible in context but not part of this diff) is not an issue here, but the new section could benefit from a brief introductory sentence linking it back to the task workflow.
  • AI Readiness: 8/10 - The internalScope field is well-written and follows the template pattern. The new ## How to identify chats with outstanding tasks heading is task-based and searchable. The added keyword task badge improves discoverability. Minor deduction: the existing article still uses multiple # headings (# Create a Task, # Edit a Task) which violates the single-#-title rule from HELP_AUTHORING_GUIDELINES.md Section 4, but since those are pre-existing and not part of this diff, they are not scored here.
  • Style Compliance: 9/10 - UI element references are bolded correctly (Task, Submit, Approve, Pay, Fix). Terminology is consistent with naming conventions. The horizontal rule separator before the new section follows the existing article pattern.

Key Findings

  • Positive: The internalScope metadata addition is well-crafted, clearly stating the audience ("all Expensify users"), what the article covers ("assigning and tracking tasks in chat"), and what it excludes ("workspace-level task reporting"). This follows the template exactly.
  • Positive: The new ## How to identify chats with outstanding tasks heading is properly task-based, starts with "How to", includes the feature context, and uses the correct ## level -- fully compliant with heading rules.
  • Positive: UI labels like Task, Submit, Approve, Pay, and Fix are correctly bolded per Button Naming Standards.
  • Minor observation: The new section introduces workspace-chat-specific behavior (the Task badge appears in workspace chats). The internalScope states "does not cover workspace-level task reporting," which is accurate since this is about badge visibility rather than reporting. However, authors should confirm this distinction is intentional and clear to readers.

Recommendations

  1. No blocking issues -- the proposed changes are compliant with governance rules and ready to merge from a documentation standards perspective.
  2. Future improvement (out of scope for this PR): The pre-existing # Create a Task and # Edit a Task headings violate the single-#-title rule (only one # heading allowed, which should be the article title). A follow-up PR could demote these to ## headings to bring the full article into compliance.
  3. Consider whether the Task badge section warrants its own brief mention in the article's opening paragraph, so readers scanning the top of the article know this content exists.

Files Reviewed

  • docs/articles/new-expensify/chat/Assign-Tasks.md - Three additions: keyword expansion, internalScope metadata, and new Task badge section. All changes are governance-compliant.

@stephanieelliott
stephanieelliott requested a review from a team June 5, 2026 02:20
@melvin-bot

melvin-bot Bot commented Jun 5, 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 @lschurr

@melvin-bot
melvin-bot Bot requested review from lschurr and removed request for a team June 5, 2026 02:20
@melvin-bot

melvin-bot Bot commented Jun 5, 2026

Copy link
Copy Markdown

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

@stephanieelliott

Copy link
Copy Markdown
Contributor

Bump @lschurr, can you review plz?

@lschurr
lschurr merged commit 61a6c4d into main Jun 9, 2026
20 checks passed
@lschurr
lschurr deleted the melvin-docs-task-action-badge branch June 9, 2026 22:52
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/lschurr in version: 9.4.2-0 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/lschurr in version: 9.4.4-1 🚀

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

Bundle Size Analysis (Sentry):

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/Julesssss in version: 9.4.4-3 🚀

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.

5 participants