Skip to content

Docs updates for E/A#76741 Update edit message docs for mobile composer#90801

Merged
VictoriaExpensify merged 1 commit into
mainfrom
docs/edit-message-mobile-composer
May 22, 2026
Merged

Docs updates for E/A#76741 Update edit message docs for mobile composer#90801
VictoriaExpensify merged 1 commit into
mainfrom
docs/edit-message-mobile-composer

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary

  • Updates the "Edit or Delete Messages" section in Chat-Features-and-Moderation-Tools.md to reflect the new editing mechanism introduced in New editing mechanism for small screens #76741
  • Separates desktop and mobile instructions: desktop uses inline editing, mobile now uses the bottom composer
  • Adds platform-specific steps for initiating edits (right-click on desktop, long-press on mobile)

Related PR

#76741

Test plan

  • Verify the updated help article renders correctly on the help site
  • Confirm the desktop editing flow matches the documented steps
  • Confirm the mobile editing flow matches the documented steps (message appears in bottom composer)

Reflect the new editing mechanism where mobile uses the bottom composer
instead of inline editing, while desktop retains inline editing.

Co-authored-by: Alexey Kureev <Kureev@users.noreply.github.com>
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label May 15, 2026
@stephanieelliott stephanieelliott marked this pull request as ready for review May 20, 2026 00:52
@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates the "Edit or Delete Messages" section to separate desktop and mobile editing flows, reflecting a product change where mobile editing now uses the bottom composer. The change is small and well-scoped. There are a few style consistency issues to address, but the content itself is clear and actionable.

Scores Summary

  • Readability: 8/10 - Steps are clear, sequential, and action-oriented. The desktop/mobile split improves scannability. Step 4 in the mobile section is slightly long and could be tightened.
  • AI Readiness: 7/10 - No new headings or metadata changes are introduced. The diff is narrowly scoped to step content, which is fine. No regressions here.
  • Style Compliance: 6/10 - Two issues: (1) The diff uses "Desktop:" and "Mobile:" as platform labels, but the same file already uses "On Desktop:" and "On Mobile:" in the Send Messages section above. The labels should be consistent within the article. (2) Per the naming conventions, the non-mobile platform should be referred to as "Web" rather than "Desktop" -- the governance file uses "Web" throughout its navigation instruction standards. Both labels in the diff should match the existing pattern: "On Web:" / "On Mobile:" or at minimum "Web:" / "Mobile:".

Key Findings

  • The platform-specific split is a good improvement -- it correctly distinguishes right-click (web) from long-press (mobile) interactions, and documents the new composer-based editing flow on mobile.
  • The platform labels ("Desktop:" vs "On Desktop:" vs "Web:") are inconsistent with both the governance conventions and the existing content earlier in the same file.
  • Button names (Edit comment, Delete comment, Enter, Send) are correctly bolded and match expected UI labels.
  • The mobile step 4 ("the message text appears in the composer at the bottom of the screen. Edit the text and tap the Send icon to save.") mixes an observation with an action. Consider splitting: step 4 could be "Edit the text in the composer at the bottom of the screen" and step 5 could be "Tap the Send icon to save."

Recommendations

  1. Change "Desktop" to "Web" to align with the naming conventions governance, which consistently uses "Web" (not "Desktop") as the platform label.
  2. Use the same label format as the rest of the file: Earlier in this article, the pattern is "On Web:" / "On Mobile:". The new section should match: use "On Web:" and "On Mobile:" (or update both sections to be consistent).
  3. Consider splitting mobile step 4 into two steps for clarity -- one for editing in the composer, one for tapping Send.
  4. The removed line "To edit or delete a message:" is fine to drop since the platform labels now serve as the section intro.

Files Reviewed

  • docs/articles/new-expensify/chat/Chat-Features-and-Moderation-Tools.md - Platform-specific edit/delete instructions added; needs label consistency fixes.

Note: This review covers only the proposed changes in the diff, not pre-existing content.

@stephanieelliott stephanieelliott self-assigned this May 20, 2026
@stephanieelliott stephanieelliott requested a review from a team May 20, 2026 01:13
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 20, 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 @VictoriaExpensify

@melvin-bot melvin-bot Bot requested a review from VictoriaExpensify May 20, 2026 01:13
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 20, 2026

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

@melvin-bot melvin-bot Bot removed the request for review from a team May 20, 2026 01:13

**To edit or delete a message:**

**Desktop:**
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 convention: The governance file (HELPSITE_NAMING_CONVENTIONS.md, Navigation Instruction Standards) uses "Web:" and "Mobile:" as the standard platform labels when providing separate instructions. Consider using **Web:** instead of **Desktop:** to align with the convention. Additionally, the existing sections earlier in this same file use the "On Desktop:" / "On Mobile:" pattern (lines 19, 26) -- whichever label is chosen, it should be consistent throughout the article.

1. Open a chat.
2. Right-click a message.
3. Select **Edit comment** or **Delete comment**.
4. If editing, modify the message inline and press **Enter** to save.
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: Per HELP_AUTHORING_GUIDELINES.md Section 5, steps must be sequential, clear, and action-oriented. This conditional step ("If editing...") mixes the edit and delete flows into one procedure. Consider splitting into two separate step lists -- one for editing and one for deleting -- so each flow is a clean sequential set of actions.

@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR updates the "Edit or Delete Messages" section to document platform-specific behavior for desktop (inline editing) and mobile (composer-based editing). The change is small, focused, and well-motivated by the feature change in #76741. The instructions are clear and properly separated by platform.

Scores Summary

  • Readability: 8/10 - Steps are clear, sequential, and action-oriented. The platform separation makes it easy to follow the right flow. The conditional phrasing ("If editing...") in step 4 of each platform block is functional but slightly breaks the pure sequential step pattern.
  • AI Readiness: 6/10 - The existing article structure (which this PR inherits but does not change) uses # Edit or Delete Messages as a noun-phrase heading rather than a task-based heading (e.g., "How to edit or delete messages"). However, since the PR only modifies content within that section and does not introduce new headings, this is not a defect introduced by this PR. The changed content itself is well-structured for retrieval.
  • Style Compliance: 8/10 - UI element references are bolded correctly (Edit comment, Delete comment, Send, Enter). Platform labels "Desktop:" and "Mobile:" are used as bold inline labels rather than headings, which is an acceptable pattern already established in this article (see the "Sending Messages" section above). The naming conventions doc prohibits platform-only headings, but these are not headings -- they are inline labels, so no violation occurs.

Key Findings

  • The platform separation pattern (bold label + numbered steps) is consistent with the existing "Sending Messages" section earlier in the same article, maintaining internal consistency.
  • All button and action names are bolded and match expected UI terminology: Edit comment, Delete comment, Send, Enter.
  • The mobile step 4 is slightly long but necessarily so, as it describes a different UX flow (composer at bottom of screen). This is appropriate documentation of the behavioral difference.
  • No new headings were introduced, so no heading-rule violations are attributable to this PR.

Recommendations

  • No blocking issues. This PR is ready to merge from a documentation quality standpoint.
  • Minor: Consider whether step 4 on mobile could be split into two steps for scannability (e.g., step 4: "Edit the text in the composer at the bottom of the screen." step 5: "Tap the Send icon to save."). This is optional and stylistic.
  • Pre-existing (not introduced by this PR): The parent heading # Edit or Delete Messages is noun-based rather than task-based per HELP_AUTHORING_GUIDELINES.md Section 2. A future pass could rename it to something like # How to edit or delete messages. This is not a blocker for this PR.

Files Reviewed

  • docs/articles/new-expensify/chat/Chat-Features-and-Moderation-Tools.md -- Platform-specific edit/delete instructions added. Clean, consistent with existing article patterns. No governance violations in the proposed changes.

@VictoriaExpensify VictoriaExpensify merged commit 8dc363e into main May 22, 2026
34 of 36 checks passed
@VictoriaExpensify VictoriaExpensify deleted the docs/edit-message-mobile-composer branch May 22, 2026 02:21
@melvin-bot
Copy link
Copy Markdown

melvin-bot Bot commented May 22, 2026

@VictoriaExpensify 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.

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/VictoriaExpensify in version: 9.3.80-0 🚀

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

Bundle Size Analysis (Sentry):

@kavimuru
Copy link
Copy Markdown

@stephanieelliott what should we QA here?

@OSBotify
Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 9.3.81-2 🚀

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