[No QA] Restructure Workspace Merchant Rules examples into their own section - #93490
Conversation
…with sub-sections Co-authored-by: Brian Lee <brianlee-expensify@users.noreply.github.com>
This comment has been minimized.
This comment has been minimized.
Concierge reviewer checklist:
For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member? |
|
@twisterdotcom 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] |
HelpDot Documentation ReviewOverall AssessmentThis PR modifies heading levels in the "Examples of Workspace Merchant Rules" section of the Workspace Merchant Rules article. It promotes a Scores Summary
Key FindingsGovernance violations introduced by the diff:
Positive aspects:
Recommendations
Files Reviewed
Review based on governance files: HELP_AUTHORING_GUIDELINES.md, HELPSITE_NAMING_CONVENTIONS.md, and TEMPLATE.md. |
| --- | ||
|
|
||
| ## Examples of Workspace Merchant Rules | ||
| # Examples of Workspace Merchant Rules |
There was a problem hiding this comment.
Heading hierarchy violation: Articles must have exactly one # heading (the article title), plus an optional # FAQ. No other # headings are allowed (HELP_AUTHORING_GUIDELINES.md, Sections 4 and 9).
This creates a second # heading in the article. Additionally, "Examples of Workspace Merchant Rules" is a noun-only/topic-only heading, which is forbidden — all headings must be task-based, starting with an action verb or question word (Section 2).
Suggested fix: Demote this to ## and rephrase as a task-based heading, e.g.:
| # Examples of Workspace Merchant Rules | |
| ## How to use Workspace Merchant Rules |
|
Hm, I do agree that the formatting isn't the best for human readability, but I don't think moving them into their own headers is a good fix from a retrieval perspective. Headers are a little tricky, because AZ treats anything with a TBH I think the ultra-detailed examples aren't adding much to the article - @brianlee-expensify what do you think of doing something like this instead?
|
|
@stephanieelliott ah helpful to know, thank you! and yes your suggestion looks good to me! |
|
Cool! I made the change in the doc -- adding another reviewer since we've both committed to this one! |
Concierge reviewer checklist:
For more detailed instructions on completing this checklist, see How do I review a HelpDot PR as a Concierge Team member? cc @sakluger |
|
@stephanieelliott are you sure you committed those changes? When I review the PR, it's still showing the individual headers for each example. |
This comment has been minimized.
This comment has been minimized.
|
@MelvinBot when I review the adhoc build help page, the
|
|
Root cause: Line 62 has a stray leading space before the Expensify Help renders these articles with Jekyll/kramdown, which only treats a line as an ATX heading when the See Fix: Remove the leading space so the line is exactly Want me to push that fix to this PR? Reply |
|
@MelvinBot fix it. |
|
The fix is a one-character change: remove the leading space before I can only make code changes when directed by the PR author, an assignee, or an existing co-author. To have me implement this, the PR assignee or author should reply with a request tagging me. |
|
A preview of your ExpensifyHelp changes have been deployed to https://d675cf22.helpdot.pages.dev ⚡️ Updated articles: |
|
@sakluger can you approve this now, or does this require a new review from yet another person? 😂 |
|
I can approve. |
|
🚀 Deployed to staging by https://github.com/twisterdotcom in version: 9.4.34-0 🚀
|
|
🚀 Deployed to production by https://github.com/roryabraham in version: 9.4.34-14 🚀
|
|
🚀 Deployed to production by https://github.com/roryabraham in version: 9.4.34-14 🚀
Bundle Size Analysis (Sentry): |

Explanation of Change
Restructures the Examples of Workspace Merchant Rules content in the Workspace Merchant Rules help article so the individual examples are easier to parse.
##sub-section to its own top-level#section.##sub-section.This gives each example a proper heading in the article hierarchy and table of contents, making the section easier to scan and navigate. No content wording was changed — only the heading levels.
Requested by
brianlee-expensifyin Slack.Fixed Issues
$
PROPOSAL:
Tests
// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review"
// Please describe what tests you performed that validates your changed worked.
Offline tests
N/A — documentation-only change.
QA Steps
// TODO: The human co-author must fill out the QA tests you ran before marking this PR as "ready for review".
// Please describe what QA needs to do to validate your changes and what areas do they need to test for regressions.
PR Author Checklist
### Fixed Issuessection aboveTestssectionOffline stepssectionQA stepssectionScreenshots/Videos
N/A — documentation-only change (heading-level restructuring of an existing help article).