Skip to content

[No QA] Docs updates for E/A#94131 surface RuleBot in Agent rules section#94636

Merged
stephanieelliott merged 3 commits into
mainfrom
melvin-docs-rulebot-rules-surface
Jul 1, 2026
Merged

[No QA] Docs updates for E/A#94131 surface RuleBot in Agent rules section#94636
stephanieelliott merged 3 commits into
mainfrom
melvin-docs-rulebot-rules-surface

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Summary

This updates the help site to reflect Expensify/App#94131, which surfaces RuleBot directly in the Agent rules section under Workspace > Rules. After RuleBot is provisioned (on the first Agent Rule), the section now shows the line Agent rules are enforced by followed by a RuleBot pill.

What changed

  • docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md — added a sentence to the What happens after an Agent Rule is created section noting that the Agent rules section displays the Agent rules are enforced by RuleBot line once RuleBot exists, and that the line isn't shown before the first Agent Rule.

Why this is the only change needed

The existing Agent Rules articles already document that RuleBot is created automatically on the first Agent Rule and that it enforces Agent Rules. The only new user-visible behavior in the PR is that the Agent rules section now visually surfaces RuleBot, so a single accurate sentence keeps the docs in sync without duplicating already-covered concepts.

Guidelines applied

  • HELPSITE_NAMING_CONVENTIONS.md — referenced the exact UI text (Agent rules, Agent rules are enforced by) with bold formatting, matching the live labels in src/languages/en.ts.
  • HELP_AUTHORING_GUIDELINES.md — content added under an existing task-based ## section; no new headings introduced.
  • TEMPLATE.md — change is a minimal in-place addition to an existing compliant article.

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

Co-authored-by: Yuwen Memon <yuwenmemon@users.noreply.github.com>
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Jun 25, 2026
@github-actions github-actions Bot changed the title Docs updates for E/A#94131 surface RuleBot in Agent rules section [No QA] Docs updates for E/A#94131 surface RuleBot in Agent rules section Jun 25, 2026
@OSBotify

This comment has been minimized.

@yuwenmemon yuwenmemon marked this pull request as ready for review June 25, 2026 22:13
Comment thread docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md Outdated
@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment
This PR adds a single sentence to Create-Agent-Rules.md under the existing "What happens after an Agent Rule is created" section, documenting that the Agent rules section now surfaces an "Agent rules are enforced by" line followed by RuleBot once RuleBot is provisioned. The change is small, accurate, and correctly placed within an existing task-based section without introducing new headings, a clean minimal docs-sync update.

Scores Summary

  • Readability: 7/10 - The sentence is clear but somewhat long and slightly repetitive ("so you can see which agent enforces your rules" plus a second clause restating that the line only appears after the first Agent Rule). The two ideas could be tightened into a crisper statement.
  • AI Readiness: 8/10 - Added under an existing task-based section heading; no heading hierarchy or metadata regressions. Feature names are spelled out and the article YAML and internalScope remain intact. No new retrieval phrasing was added, but none was required for an in-place clarification.
  • Style Compliance: 6/10 - UI strings are bolded per the naming conventions, but there is a capitalization inconsistency: the new text uses "Agent rules" (lowercase r) while the rest of the article references the same UI element as "Agent Rules" (capital R), e.g. "In the Agent Rules section". Per HELPSITE_NAMING_CONVENTIONS.md, UI labels must match the product exactly and be used consistently. Please confirm the live label and align both usages.

Key Findings

  • Positive: Correctly scoped, minimal change placed in the right existing section with no new top-level headings, consistent with the authoring guidelines and TEMPLATE structure.
  • Positive: UI text is treated as a label and bolded appropriately.
  • Issue (must address): Inconsistent casing of the same UI element, "Agent rules" vs. "Agent Rules", within the same article. Verify the exact label in src/languages/en.ts and make both references identical.
  • Minor: The sentence is wordy; the trailing clause restates what is already implied.

Recommendations

  • Priority: Confirm the exact UI casing and make the new sentence "Agent rules" / "Agent rules are enforced by" match the established "Agent Rules" usage elsewhere in the file (or update all instances if the live UI changed).
  • Suggestion: Tighten to something like: "Once RuleBot is created, the Agent Rules section shows an Agent rules are enforced by line naming RuleBot. This line only appears after you add your first Agent Rule."

Files Reviewed

  • docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md - Approve with minor changes; address the UI casing consistency before merge.

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

Comment thread docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md Outdated
@stephanieelliott stephanieelliott requested a review from a team June 26, 2026 21:01
@melvin-bot

melvin-bot Bot commented Jun 26, 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 a review from kadiealexander June 26, 2026 21:01
@melvin-bot

melvin-bot Bot commented Jun 26, 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]

@melvin-bot melvin-bot Bot removed the request for review from a team June 26, 2026 21:01
@OSBotify

This comment has been minimized.

@yuwenmemon

Copy link
Copy Markdown
Contributor

@kadiealexander @stephanieelliott bump for a re-review

@OSBotify

OSBotify commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

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

Updated articles:

@stephanieelliott stephanieelliott merged commit 25a9d07 into main Jul 1, 2026
20 checks passed
@stephanieelliott stephanieelliott deleted the melvin-docs-rulebot-rules-surface branch July 1, 2026 20:46
@OSBotify

OSBotify commented Jul 3, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/stephanieelliott in version: 9.4.27-1 🚀

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

@OSBotify

OSBotify commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/grgia in version: 9.4.27-2 🚀

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