Skip to content

[No QA] Docs updates for E/A#96773 Agent rule change log audit trail - #97549

Merged
stephanieelliott merged 2 commits into
mainfrom
melvin-docs-agent-rule-changelog-96773
Aug 5, 2026
Merged

stephanieelliott merged 2 commits into
mainfrom
melvin-docs-agent-rule-changelog-96773

Conversation

@MelvinBot

@MelvinBot MelvinBot commented Jul 31, 2026 •

Copy link
Copy Markdown
Contributor

@stephanieelliott please review

Explanation of Change

Companion help-site update for Expensify/App#96773, which renders the new Agent rule change-log system messages (POLICYCHANGELOG_{ADD,UPDATE,DELETE}_AGENT_RULE) in NewDot's #admins room as a visible audit trail.

Updates docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md:

  • Adds a How to edit an Agent rule section (the update flow was previously undocumented; "update" is one of the three logged actions).
  • Adds a How Agent rule changes are recorded in the #admins room section describing the add/update/delete audit trail, including that add/update record the rule title and prompt while delete records only the title, and that the #admins room LHN preview shows a concise summary.
  • Adds a matching FAQ entry and retrieval keywords.

All UI labels were verified against the current App source (src/languages/en.ts): section Agent rules, button Add AI rule, and the Edit rule / Delete rule flows.

Related PRs


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

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 Jul 31, 2026
@github-actions github-actions Bot changed the title Docs updates for E/A#96773 Agent rule change log audit trail [No QA] Docs updates for E/A#96773 Agent rule change log audit trail Jul 31, 2026
@OSBotify

This comment has been minimized.

@yuwenmemon

Copy link
Copy Markdown
Contributor

@MelvinBot mark this PR as ready for review

@yuwenmemon
yuwenmemon marked this pull request as ready for review August 5, 2026 05:34
@yuwenmemon

Copy link
Copy Markdown
Contributor

@MelvinBot resolve the conflicts.

@MelvinBot

Copy link
Copy Markdown
Contributor Author

✅ This PR is marked as ready for review — it's out of draft state and open.

stephanieelliott is already tagged as the reviewer. Since this is a docs-only change (docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md), no App testing is needed.

2. Click **Rules**.
3. In the **Agent rules** section, select the AI rule you want to change.
4. Update the natural-language description of the behavior you want.
5. Click **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.

Button naming violation: The UI button for saving an Agent rule is Save rule (agentRules.saveRule in src/languages/en.ts), not Save. Per HELPSITE_NAMING_CONVENTIONS.md, use the exact UI label and do not shorten it. Change to Click **Save rule**.

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds two new sections and an FAQ entry to Create-Agent-Rules.md documenting the new Agent rule editing flow and the #admins room audit trail (add/update/delete system messages). The changes are focused, well-scoped, and align closely with the existing article's established patterns and voice. The additions respect the single-workflow-per-article principle and reinforce the primary Agent rules workflow.

Scores Summary

  • Readability: 9/10 - Clear, concise, action-oriented steps and scannable bullet formatting. The audit-trail bullets (Added/Updated/Deleted) are easy to parse.
  • AI Readiness: 9/10 - Both new ## headings are task-based ("How to edit...", "How Agent rule changes are recorded..."), use the full feature name, and heading hierarchy stays at #/##. Keywords were meaningfully expanded (edit agent rule, agent rule history, admins room audit trail) to match real search intent. The FAQ addition follows the question format.
  • Style Compliance: 8/10 - UI labels (Rules, Agent rules section, Save) are bolded and match the create flow; navigation uses the approved unified web/mobile phrasing; the cross-link uses descriptive anchor text with a relative link. Minor casing inconsistency noted below.

Key Findings

  • Positive: The new How to edit an Agent rule section mirrors the existing create/delete step structure exactly, keeping the article internally consistent.
  • Positive: Cross-link anchor text ("Learn how to find the #admins room for a workspace") is descriptive and uses a relative link, per Cross-Linking Standards. It is placed after an explanatory sentence, not inside a numbered step.
  • Positive: The audit-trail section clearly differentiates what add/update vs. delete record, matching the source behavior.
  • Minor: Casing consistency for the Agent rules section label. The added edit section correctly uses Agent rules (matching the create flow), but the pre-existing delete section nearby uses Agent Rules. Since this PR touches the file, aligning on the exact UI casing throughout would improve Style Compliance.
  • Minor: The bulleted lines in the audit-trail section use a leading space before the dash ( - **Added:**); standard list formatting (no leading space) matches the rest of the article.

Recommendations

  • Confirm and standardize the section label casing to the exact UI string (Agent rules vs Agent Rules) across the article.
  • Normalize the leading-space bullets in the audit-trail section to match the article's other lists.
  • No blocking issues; changes are ready pending the minor casing/formatting cleanup.

Files Reviewed

  • docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md - Two new task-based sections plus one FAQ entry and expanded keywords. Compliant with structure, heading, and cross-linking rules; minor UI-casing/formatting nits.

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

…/App into melvin-docs-agent-rule-changelog-96773

Co-authored-by: Yuwen Memon <yuwenmemon@users.noreply.github.com>

# Conflicts:
#	docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md
@MelvinBot

Copy link
Copy Markdown
Contributor Author

✅ Conflicts resolved and pushed — the PR is now mergeable.

There was one conflict in docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md: main had independently merged a section documenting the same #admins-room audit trail (titled "How to review Agent rule changes in the #admins room"), which overlapped with this PR's section.

I resolved it by keeping main's canonical wording and folding in the one detail unique to this PR — the line noting that the #admins room's chat-list preview shows a concise summary. Nothing was dropped.

Since this touched documentation wording, please give the resolved section a quick look to confirm it reads the way you want.

@OSBotify

OSBotify commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

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

Updated articles:

@MelvinBot

Copy link
Copy Markdown
Contributor Author

The only failing check is Check independent approval, and it's not a code problem — there's nothing to push a fix for.

It fails because the PR has no independent Expensify-employee approval yet:

Insufficient independent peer review { approvers: [], independentApprovers: [] }
Expensify/App#97549 does not have enough independent Expensify employee approvals.

Every other check is passing, skipping, or a still-running build. This is a docs-only change (single markdown file), so this gate clears itself once an independent Expensify employee reviews and approves the PR — no commit from me will satisfy it.

Next step: have an Expensify employee other than the author review/approve, then re-run the check.

@stephanieelliott
stephanieelliott merged commit 1025e4d into main Aug 5, 2026
24 of 25 checks passed
@stephanieelliott
stephanieelliott deleted the melvin-docs-agent-rule-changelog-96773 branch August 5, 2026 07:26
@OSBotify OSBotify mentioned this pull request Aug 5, 2026
46 tasks done
@OSBotify

OSBotify commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

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

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/roryabraham in version: 9.4.51-1 🚀

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