Skip to content

[No QA] Create Suggested agent rules reference doc - #97941

Merged
kadiealexander merged 7 commits into
mainfrom
helpsite-add-agent-suggested-rules
Aug 12, 2026
Merged

[No QA] Create Suggested agent rules reference doc#97941
kadiealexander merged 7 commits into
mainfrom
helpsite-add-agent-suggested-rules

Conversation

@stephanieelliott

@stephanieelliott stephanieelliott commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Added Suggested rules template description and updated the instructions for creating Agent rules, including changes to the keywords and the steps for adding a rule.

Replaces: #96542

Updated the instructions for creating Agent rules, including changes to the keywords and the steps for adding a rule.
@github-actions github-actions Bot changed the title Revise Agent rules creation process and keywords [No QA] Revise Agent rules creation process and keywords Aug 6, 2026
@OSBotify

This comment has been minimized.

Updated links in the Use Suggested Agent Rules document to reflect new article titles.
@OSBotify

This comment has been minimized.

@stephanieelliott stephanieelliott added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Aug 6, 2026
@OSBotify

This comment has been minimized.

Comment thread docs/articles/new-expensify/ai-agents/Use-Suggested-Agent-Rules.md Outdated
@stephanieelliott stephanieelliott changed the title [No QA] Revise Agent rules creation process and keywords [No QA] Create Suggested agent rules reference doc Aug 6, 2026

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e7371d69b9

ℹ️ About Codex in GitHub

Codex has been enabled to automatically 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 👍.

When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".

Comment thread docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md
@OSBotify

This comment has been minimized.

…s.md

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@stephanieelliott
stephanieelliott requested a review from a team August 6, 2026 07:32
@melvin-bot

melvin-bot Bot commented Aug 6, 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 @RachCHopkins

@melvin-bot
melvin-bot Bot requested a review from RachCHopkins August 6, 2026 07:32
@melvin-bot

melvin-bot Bot commented Aug 6, 2026

Copy link
Copy Markdown

@RachCHopkins 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 August 6, 2026 07:32
@OSBotify

This comment has been minimized.

@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment
This PR revises the Agent rules creation flow in Create-Agent-Rules.md (removes beta gating, updates the add-rule steps for the new Suggested/Edit tab experience, expands keywords) and adds a substantial new reference article, Use-Suggested-Agent-Rules.md, cataloging every prewritten suggested rule with its behavior and default instruction. The changes are well-structured, accurate to the UI flow, and cross-linked appropriately. A couple of small fixes are needed before merge.

Scores Summary

  • Readability: 9/10 - Clear, scannable prose; the suggested-rules tables (rule / what it does / default instruction) are an excellent, consistent format. Steps are sequential and action-oriented.
  • AI Readiness: 8/10 - Strong YAML on both files including internalScope, plus retrievalIntent/contentType on the new file. Single-workflow scoping is respected and cross-links reinforce scope. Only top-level and second-level headings are used with a compliant FAQ heading.
  • Style Compliance: 8/10 - UI terminology is exact and consistently bolded (Add agent rule, Suggested, Edit, Find a rule, Next, Save). Navigation uses the approved unified phrasing. FAQ follows the question-heading structure. Points off for one malformed link and a few category-style section headings.

Key Findings

  • Positive: Removing the beta-access prerequisites and the beta bullet correctly reflects GA; the revised steps accurately describe the new Suggested/Edit tab flow.
  • Positive: The new article uses exact, bolded UI labels throughout and keeps to a single workflow, with proper relative cross-links to Create Agent Rules and How to Write Agent Rules.
  • Must fix: In Use-Suggested-Agent-Rules.md the link to How to Write Agent Rules ends with a stray trailing slash after the closing parenthesis, which renders a stray slash after the link and should be removed.
  • Minor: Several section headings are category-style (for example, "What amount and spending rules are available"). They start with What and are searchable so they pass, but tightening them toward the reader task would improve retrieval-intent consistency.

Recommendations

  • Priority: Remove the trailing slash on the How to Write Agent Rules cross-link.
  • Optional: Confirm the default-instruction example amounts/currencies match current product copy so the doc stays literal to the UI.
  • Optional: Consider phrasing the category-style section headings as reader questions for slightly stronger AI-retrieval alignment.

Files Reviewed

  • docs/articles/new-expensify/ai-agents/Create-Agent-Rules.md - Updated steps and keywords; accurate and compliant.
  • docs/articles/new-expensify/ai-agents/Use-Suggested-Agent-Rules.md - New reference article; strong structure, one link fix needed.

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

@RachCHopkins

Copy link
Copy Markdown
Contributor

We have a stray slash in the Suggested doc

image

I assume it should be a full point.

I suspect this should be a table:

image

@RachCHopkins RachCHopkins left a comment

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.

Needs a couple of corrections!

Comment thread docs/articles/new-expensify/ai-agents/Use-Suggested-Agent-Rules.md Outdated
| Suggested Agent rule | What it does | Default instruction |
| --- | --- | --- |
| **Billable status** | Approves or rejects expenses based on whether they're billable. | Only approve non-billable expenses. Reject any expense marked as billable to a client. |
For guidance on writing clear, effective instructions, see [How to Write Agent Rules](/articles/new-expensify/ai-agents/How-to-Write-Agent-Rules).

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.

Delete this line

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.

Line 76, to be specific

stephanieelliott and others added 2 commits August 6, 2026 15:44
Co-authored-by: Rachael Hopkins <32854888+RachCHopkins@users.noreply.github.com>
@stephanieelliott

Copy link
Copy Markdown
Contributor Author

Thanks @RachCHopkins, corrected!

@OSBotify

This comment has been minimized.

@OSBotify

OSBotify commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

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

Updated articles:

@RachCHopkins

Copy link
Copy Markdown
Contributor

@MelvinBot what is failing here? Why can't I merge this?

@MelvinBot

Copy link
Copy Markdown
Contributor

Nothing is broken in the code — every build/lint/test check is passing. The merge is blocked purely on review.

Why you can't merge: the PR needs an approving review and doesn't have one yet. The one failing check, Check independent approval, verifies the PR has been approved by an independent reviewer (someone other than the author). Right now all five reviews are COMMENTED — there are zero APPROVED reviews — so GitHub reports REVIEW_REQUIRED and the merge state is BLOCKED.

To unblock: get a reviewer to click Approve (not just leave comments). Once there's one independent approval, Check independent approval will pass and the merge button will unlock.

Check details
Check Result
build, check, verify, validate, dryRun, spellcheck, actionlint, CLA, verifySignedCommits, etc. ✅ pass
Check independent approval ❌ fail (no approving review)
approveAndMerge, Warn deployers ⏭️ skipping (gated behind the above)

mergeable: MERGEABLE, mergeStateStatus: BLOCKED, reviewDecision: REVIEW_REQUIRED.

@kadiealexander
kadiealexander self-requested a review August 12, 2026 00:46
@kadiealexander

Copy link
Copy Markdown
Contributor

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified that the composer does not automatically focus or open the keyboard on mobile unless explicitly intended. This includes checking that returning the app from the background does not unexpectedly open the keyboard.
  • I verified tests pass on all platforms & I tested again on:
    • Android: HybridApp
    • Android: mWeb Chrome
    • iOS: HybridApp
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
    • MacOS: Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified there are no new alerts related to the canBeMissing param for useOnyx
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • For any bug fix or new feature in this PR, I verified that sufficient unit tests are included to prevent regressions in this flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: HybridApp
Android: mWeb Chrome
iOS: HybridApp
iOS: mWeb Safari
MacOS: Chrome / Safari
MacOS: Desktop

@kadiealexander
kadiealexander merged commit 675c1b9 into main Aug 12, 2026
16 of 17 checks passed
@kadiealexander
kadiealexander deleted the helpsite-add-agent-suggested-rules branch August 12, 2026 00:46
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/kadiealexander in version: 9.4.53-0 🚀

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