Skip to content

[No QA] Docs updates for E/A#100356 correct Report fields article to match current UI - #100515

Draft
MelvinBot wants to merge 1 commit into
mainfrom
claude-fixReportFieldsArticle
Draft

[No QA] Docs updates for E/A#100356 correct Report fields article to match current UI#100515
MelvinBot wants to merge 1 commit into
mainfrom
claude-fixReportFieldsArticle

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Docs-only follow-up to #100356. While checking whether that PR needed help site updates, I compared docs/articles/new-expensify/workspaces/Enable-Report-Fields.md against the live product and found the article no longer matches the UI. That PR itself needs no docs change — this fixes the drift I found next to it.

Accuracy fixes (each verified against the current UI on web):

Article said Product shows
Enable via More Features The toggle is on the Reports tab. More features has no report fields entry.
Report Fields Report fields
Add Field Add field
Field Type Type
List Values > Add Values List values > Add value
Three types: Text, Date, List Four types: Text, Date, List, Formula
"Make your edits in the right-hand panel" Name and Type are read-only once saved; only List values and Initial value can be edited
No mention of Initial value Initial value exists and is required for List fields

The wrong navigation path was the most costly error — an admin following the old article looks under More features, finds nothing, and concludes the feature is missing from their workspace.

Compliance fixes against docs/HELP_AUTHORING_GUIDELINES.md, docs/HELPSITE_NAMING_CONVENTIONS.md, and docs/TEMPLATE.md:

  • Collapsed three # headings into one # title plus # FAQ, as required — all content sections are now ##.
  • Made every heading task-based (starts with an action verb or question word).
  • Added the mandatory internalScope metadata key, which was missing.
  • Removed a dead [Learn more about connecting integrations.](#) link that pointed nowhere.
  • Added one <!-- SCREENSHOT: --> suggestion in the required format for the Reports tab location.

The filename is unchanged, so the published URL still resolves. The title changed from "Enable Report Fields" to "Create and Manage Report Fields" because the single permitted # heading now has to cover the create, edit, and delete sections too.

UI evidence for the labels used in the article

The Report fields toggle on the Reports tab:

Reports tab with the Report fields toggle

The four field types:

Type page listing Text, Date, List, Formula

The List values page and its Add value button:

List values page with the Add value button

A saved field, showing that Name and Type have no chevron and Delete is inline:

Saved report field showing Name, Type, List values, Initial value, Delete

AI Tests

  • ./.github/scripts/createDocsRoutes.sh — passed, docs/routes.yml already up to date (routes key off the filename, which is unchanged).
  • npm run spell-changed — passed, 0 issues.

Lint, typecheck, Jest, and Storybook were not run: this change touches one Markdown article and no application code.

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.

  • Verify that no errors appear in the JS console

Offline tests

Not applicable — this PR changes one help site Markdown article and no application code.

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.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover 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 tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • 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 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)
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • 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 new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • 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.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user 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.

Screenshots/Videos

Android: Native
Android: mWeb Chrome
iOS: Native
iOS: mWeb Safari
MacOS: Chrome / Safari

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

…tandards

Co-authored-by: Abdelhafidh Belalia <s77rt@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team September 7, 2026 13:09
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Sep 7, 2026
@github-actions github-actions Bot changed the title Docs updates for E/A#100356 correct Report fields article to match current UI [No QA] Docs updates for E/A#100356 correct Report fields article to match current UI Sep 7, 2026
@OSBotify

OSBotify commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

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

Updated articles:

@s77rt

s77rt commented Sep 7, 2026

Copy link
Copy Markdown
Member

@stephanieelliott I can't change the PR description or make this ready for review. Can you please look into that or assign someone internal

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.

3 participants