[No QA] Docs updates for E/A#96773 Agent rule change log in #admins room - #97398
[No QA] Docs updates for E/A#96773 Agent rule change log in #admins room#97398MelvinBot wants to merge 1 commit into
Conversation
Co-authored-by: Yuwen Memon <yuwenmemon@users.noreply.github.com>
|
A preview of your ExpensifyHelp changes have been deployed to https://c5ae3b1c.helpdot.pages.dev ⚡️ Updated articles: |
Concierge reviewer checklist:
For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member? |
|
@bfitzexpensify 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] |
| - **Added** and **updated** messages show the rule's title and its full prompt. | ||
| - **Deleted** messages show the rule's title. | ||
|
|
||
| Because the **#admins** room is visible only to Workspace Admins, this history stays private to your admin team. To review it, open your workspace's **#admins** room and find the relevant system message. |
There was a problem hiding this comment.
Prohibited/vague navigation phrasing: "find the relevant system message" is a vague locate-phrase similar to the prohibited "Find the setting" (HELPSITE_NAMING_CONVENTIONS.md, Prohibited Language). This heading is "How to review Agent rule changes," so give explicit, deterministic navigation for opening the room instead — e.g. reference the exact navigation to reach the #admins room (per the Navigation Instruction Standards) and describe the exact system message the reader is looking for.
|
|
||
| ## How to review Agent rule changes in the #admins room | ||
|
|
||
| Whenever an Agent rule is added, updated, or deleted, Expensify records a system message in your workspace's **#admins** room so admins have a visible history of the change. |
There was a problem hiding this comment.
Terminology consistency: Use the exact role term "Workspace Admins" rather than the informal "admins" (and "admin team" on the sentence below). HELPSITE_NAMING_CONVENTIONS.md (Deterministic Writing) and the article's own usage of Workspace Admins call for consistent, exact role terminology.
HelpDot Documentation ReviewOverall AssessmentThis PR adds a single, focused task-based section ( Scores Summary
Key Findings
Recommendations
Files Reviewed
Note: Detailed line-by-line feedback has been provided as inline comments. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 292a4d0305
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - **Added** and **updated** messages show the rule's title and its full prompt. | ||
| - **Deleted** messages show the rule's title. |
There was a problem hiding this comment.
Qualify the claim that change logs always show a title
When server-side title generation fails, these messages do not show a rule title: AgentRuleChangeLogUtils.ts explicitly treats the generated title as best-effort, add/update fall back to prompt-only messages, and delete falls back to the generic “removed an agent rule.” Documenting titles as unconditional therefore gives admins an inaccurate expectation for this supported scenario; clarify that the title appears only when available.
Useful? React with 👍 / 👎.
Explanation of Change
Documents a user-visible behavior added in #96773: whenever an Agent rule is added, updated, or deleted, Expensify now records a system message in the workspace's #admins room as an audit trail (add/update show the rule title and prompt; delete shows the title).
The existing Create Agent Rules article covers creating, writing, and deleting Agent rules but didn't mention that these changes are now logged in the #admins room, so this adds a task-based section (
## How to review Agent rule changes in the #admins room) to that article. Content followsHELP_AUTHORING_GUIDELINES.md,HELPSITE_NAMING_CONVENTIONS.md, andTEMPLATE.md, and reuses the existing UI terminology (Agent rules, RuleBot, #admins room) already established in the article and in the Expensify Chat Rooms for Admins article.Fixed Issues
$ https://github.com/Expensify/Expensify/issues/660979
PROPOSAL:
Tests
Documentation-only change (no code/UI changes).
docs/articles/new-expensify/ai-agents/Create-Agent-Rules.mdand confirm the new ## How to review Agent rule changes in the #admins room section renders correctly.Offline tests
N/A — documentation-only change.
QA Steps
Same as tests. Documentation-only change; nothing to validate in the app.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectionAvatar, I verified the components usingAvatarare working as expected)StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))Designlabel and/or tagged@Expensify/designso the design team can review the changes.mainbranch was merged into this PR after a review, I tested again and verified the outcome was still expected according to theTeststeps.@yuwenmemon, please review the files changed and confirm they reflect the current behavior. Then post a new comment saying
@MelvinBot mark this PR as ready for review.