Skip to content

[No QA] Create View-the-Top-Categories-report.md#81051

Merged
trjExpensify merged 10 commits intomainfrom
stephanieelliott-patch-31
Feb 11, 2026
Merged

[No QA] Create View-the-Top-Categories-report.md#81051
trjExpensify merged 10 commits intomainfrom
stephanieelliott-patch-31

Conversation

@stephanieelliott
Copy link
Contributor

@stephanieelliott stephanieelliott commented Jan 30, 2026

@github-actions
Copy link
Contributor

HelpDot Documentation Review

Overall Assessment

This PR introduces a new documentation file for the Top Categories report feature in New Expensify. The document provides clear, user-focused guidance for Workspace Admins, Approvers, and Auditors. The structure is well-organized with proper headings, FAQ section, and good use of context-setting introductions. However, there are several areas where the document can be strengthened for AI readiness, style compliance, and consistency with Expensify documentation standards.

Scores Summary

  • Readability: 8/10 - Well-structured content with clear headings and logical flow. The language is accessible and user-friendly. Minor issues include some redundancy and a few instances where more concise phrasing would improve clarity.
  • AI Readiness: 6/10 - Good YAML metadata and heading structure, but lacks breadcrumb navigation, has some heading inconsistencies (mixing H1 and H2 for main sections), and contains placeholder text that should be removed before merge.
  • Style Compliance: 7/10 - Generally follows Expensify voice and formatting standards. However, there are terminology inconsistencies, navigation instruction variations, and some formatting issues that need correction.

Key Findings

Positive Aspects:

  • Strong YAML frontmatter with comprehensive metadata including title, description, keywords, and internal scope
  • Clear section organization with logical progression from "what" to "how" to "why"
  • Excellent FAQ section addressing common user questions
  • Good use of role-based access information (Workspace Admins, Approvers, Auditors)
  • Contextual explanations help users understand the purpose and value of the report

Critical Issues:

  1. Placeholder content remains: "ADD A SCREENSHOT HERE" should be resolved before merging
  2. Missing breadcrumb navigation: No breadcrumb path in YAML frontmatter for AI context
  3. Inconsistent heading levels: Mixes H1 (#) and H2 (##) for main sections, should use only H2
  4. Navigation instruction inconsistencies: Different styles for web vs mobile instructions
  5. Vague reference: "Each row represents..." appears without sufficient context about where this view is

Pattern Issues:

  • Terminology varies between "expense categories" and "categories" - should be consistent
  • Some procedural lists use numbered steps, others use bullets - standardize format
  • Link formatting could be improved for better AI parsing

Recommendations

Priority Actions (Must Address Before Merge):

  1. Remove or replace the "ADD A SCREENSHOT HERE" placeholder
  2. Add breadcrumb navigation to YAML frontmatter (e.g., breadcrumb: New Expensify > Reports > Insights > Top Categories)
  3. Change the H1 heading "View the Top Categories report in New Expensify" to H2 (##)
  4. Change the H1 heading "FAQ" to H2 (##)
  5. Ensure all main section headings use H2 (##) consistently

Style and Consistency Improvements:

  1. Standardize navigation instructions format - use consistent style for web and mobile (bold labels, clear steps)
  2. Use consistent terminology throughout - prefer "category" over "expense category" once established
  3. Remove "Note:" formatting - just state the information directly
  4. Consider rephrasing "Can you..." questions to "Can I..." for user-centric FAQ
  5. Add more context to "Each row represents..." section - specify where users are viewing this

AI Readiness Enhancements:

  1. Add breadcrumb metadata to YAML frontmatter
  2. Ensure all section headings contain full feature names (already mostly done)
  3. Consider adding more specific cross-references to related features
  4. Expand the link text "Learn how to create custom reports" to be more descriptive

Content Improvements:

  1. The "How to interpret" section could include an example scenario
  2. Consider adding a "Best practices" subsection under "Ways to use"
  3. The FAQ about calculation mentions "top 10 categories" but the main content doesn't - clarify if there's a limit
  4. Export instructions in FAQ are detailed but could be streamlined

Files Reviewed

  • docs/articles/new-expensify/insights/View-the-Top-Categories-report.md - New file, requires revisions - Good foundation with clear structure and comprehensive content. Needs placeholder removal, heading hierarchy fixes, and breadcrumb navigation before merge.

Note: This assessment focuses on documentation quality, AI readability, and style compliance per HelpDot standards. Technical accuracy of feature descriptions should be verified by the product team.

@github-actions github-actions bot changed the title Create View-the-Top-Categories-report.md [No QA] Create View-the-Top-Categories-report.md Jan 30, 2026
@OSBotify
Copy link
Contributor

OSBotify commented Jan 30, 2026

Copy link

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

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: 53196d37d3

ℹ️ 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".

Copy link
Contributor

@trjExpensify trjExpensify left a comment

Choose a reason for hiding this comment

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

Looking pretty great! ❤️

@stephanieelliott stephanieelliott changed the title [No QA] Create View-the-Top-Categories-report.md [No QA] [HOLD on image] Create View-the-Top-Categories-report.md Feb 5, 2026
@stephanieelliott
Copy link
Contributor Author

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
  • 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

@stephanieelliott stephanieelliott requested review from a team as code owners February 5, 2026 04:47
@melvin-bot melvin-bot bot requested review from JmillsExpensify and removed request for a team February 5, 2026 04:47
@melvin-bot
Copy link

melvin-bot bot commented Feb 5, 2026

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

@melvin-bot melvin-bot bot requested review from johncschuster and puneetlath and removed request for a team February 5, 2026 04:47
@melvin-bot
Copy link

melvin-bot bot commented Feb 5, 2026

@puneetlath @johncschuster One of you needs to 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]

@stephanieelliott stephanieelliott changed the title [No QA] [HOLD on image] Create View-the-Top-Categories-report.md [No QA] Create View-the-Top-Categories-report.md Feb 5, 2026
@stephanieelliott
Copy link
Contributor Author

Added the image and edited to clarify the default view is bar chart but you switch to table view. Feel free to merge when you are ready @trjExpensify

@trjExpensify
Copy link
Contributor

Okay great, thanks! This is the PR I'm tracking for the change over to view:bar by default: #81074

@stephanieelliott stephanieelliott dismissed trjExpensify’s stale review February 10, 2026 20:44

Addressed the change, idk why this is is saying I didn't

Copy link
Contributor

@trjExpensify trjExpensify left a comment

Choose a reason for hiding this comment

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

All good here! 👍

@trjExpensify trjExpensify merged commit 54bc913 into main Feb 11, 2026
16 checks passed
@trjExpensify trjExpensify deleted the stephanieelliott-patch-31 branch February 11, 2026 11:34
@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/trjExpensify in version: 9.3.18-0 🚀

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

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/lakchote in version: 9.3.18-8 🚀

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants