Skip to content

[No QA] Docs updates for E/A#100138 hidden approval workflows on externally managed workspaces - #100486

Closed
MelvinBot wants to merge 2 commits into
mainfrom
claude-dewHidePeopleWorkflowsDocs
Closed

MelvinBot wants to merge 2 commits into
mainfrom
claude-dewHidePeopleWorkflowsDocs

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Help site follow-up for #100138, which hides the approval workflow UI on a workspace whose approval mode is a Dynamic External Workflow with Hide People Table Columns set. Two help articles described behavior that no longer holds on those workspaces, so both are updated. Docs-only change — no product code is touched.

docs/articles/new-expensify/workspaces/Add-Approvals.md

Adds an FAQ entry, Why can't I see the approval workflows on my workspace?, covering what an admin actually sees on an affected workspace: the Approvals toggle stays, the message "A custom approval workflow is enabled on this workspace…" replaces the workflow list, and the approval workflow cards, the search field, the Add approval workflow row, and the More menu (Import workflows and Download workflows) are all gone. It states that this applies to every role including Workspace Admins, People Admins, and the workspace owner, that a direct link to an approvals page shows a not-found page, and that the fix is to reach out to your Account Manager or Concierge. It also notes that workspaces without an Account Manager see the Concierge-only wording, since the app has both variants of that message. The article's keywords gain the phrases someone would actually search when the UI disappears.

The FAQ placement is deliberate — this is a "why is my UI different" question, not a task, and the article's own guidance for building approval workflows is unchanged for every other workspace.

docs/articles/new-expensify/workspaces/Workspace-Workflows.md

The "How to download your workflow configuration" section told admins who can manage workflows that they will see the More menu. That is now wrong on an affected workspace, where the whole menu is hidden rather than rendering download-only. A note records the exception, points to the Account Manager or Concierge for the workflow details, and cross-links the new FAQ entry.

Wording notes for the reviewer

  • No internal terminology in the articles. "Dynamic External Workflow", "DEW", and "Hide People Table Columns" are all internal — the customer-facing hook is the message they see, so the articles quote it and describe the workflow as one Expensify sets up and maintains.
  • There is a genuine terminology collision worth a second opinion: Add-Approvals.md already uses "custom approval workflow" for the per-member Control-plan workflows you build yourself, and the in-app message uses the same phrase for the externally managed workflow. The new FAQ entry quotes the message verbatim so readers can match what is on their screen, and leads with "a workflow that Expensify sets up and maintains for you" to separate the two. Tell me if you would rather the articles avoid quoting the message.
  • Every UI label used (Workflows, Approvals, Add approval workflow, More, Import workflows, Download workflows) was read back off the live Workflows page on dev NewDot web, not taken from the PR description.

Not documented, on purpose: the PR notes that Members.csv is still reachable at Members > Download CSV and that policy.employeeList still ships the approver fields to the client. That is an open engineering gap, not customer guidance, so it stays out of the help site.

Fixed Issues

$ #98491
PROPOSAL:

Tests

// TODO: The human co-author must fill out the tests they ran before marking this PR as "ready for review".

This is a docs-only change with no product code, so there is nothing to exercise in the app. What I did verify:

  1. npm run spell-changed — 2 files checked, 0 issues.
  2. Read the exact UI labels off the live Workflows page on dev NewDot web (Workflows, Approvals, Add approval workflow, More, Import workflows, Download workflows) and used that capitalization.
  3. Confirmed the cross-link anchor #why-cant-i-see-the-approval-workflows-on-my-workspace matches the slug style already used for an apostrophe FAQ heading elsewhere in the docs (Create-an-Expense.md).

What I could not verify: the rendered help site pages and the cross-link resolving on a HelpDot build.

  • Verify that no errors appear in the JS console

Offline tests

Not applicable. These are help site markdown articles with no runtime behavior and no network dependency.

QA Steps

// TODO: The human co-author must fill out the QA steps before marking this PR as "ready for review", or add "[No QA]" to the title.

Docs-only change — no app behavior changes. If QA does review it, the check is that the two articles render and the cross-link from Workspace Workflows lands on the new FAQ entry in Add Approvals.

  • 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

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

…flow workspaces

Co-authored-by: Sobit Neupane <sobitneupane@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team September 7, 2026 11:14
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Sep 7, 2026
@sobitneupane

Copy link
Copy Markdown
Contributor

@MelvinBot mark this PR as ready for review

@MelvinBot
MelvinBot marked this pull request as ready for review September 7, 2026 11:23
@MelvinBot

MelvinBot commented Sep 7, 2026 •

Copy link
Copy Markdown
Contributor Author

🤖 Done — this PR is now marked as ready for review.


view run · view recording

@melvin-bot

melvin-bot Bot commented Sep 7, 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 @Kel-Expensify

@melvin-bot
melvin-bot Bot requested review from Kel-Expensify and sobitneupane and removed request for a team September 7, 2026 11:23
@melvin-bot

melvin-bot Bot commented Sep 7, 2026

Copy link
Copy Markdown

@sobitneupane @Kel-Expensify 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]

@github-actions

github-actions Bot commented Sep 7, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This is a focused, docs-only PR that updates two workspace articles to reflect that the approval workflow UI is hidden on externally managed workspaces. Add-Approvals.md gains a new FAQ entry explaining what an admin sees when the workflow list is replaced by the in-app "custom approval workflow is enabled" message, and Workspace-Workflows.md gains a note plus a cross-link documenting that the More menu (and therefore Download workflows / Import workflows) disappears. The changes are accurate, well-scoped, and correctly keep internal terminology out of customer-facing copy.

Scores Summary

  • Readability: 9/10 - Clear, scannable prose. The verbatim blockquote of the in-app message helps readers match what is on their screen, and the plain-language lead ("a workflow that Expensify sets up and maintains for you") sensibly disambiguates the "custom approval workflow" terminology collision. The final sentence of the FAQ is slightly dense but acceptable.
  • AI Readiness: 9/10 - The new FAQ heading uses a question word (Why) and is correctly placed under # FAQ, which is exempt from task-based rules. Keywords were expanded with realistic failure-state search phrases ("cannot see approval workflow", "approval workflow hidden"), which is exactly the intent someone hits when the UI vanishes. Both articles retain valid internalScope metadata.
  • Style Compliance: 9/10 - UI labels (Workflows, Approvals, Add approval workflow, More, Import workflows, Download workflows) are bolded and match the live UI per the naming conventions. Internal terms (Dynamic External Workflow, DEW, Hide People Table Columns) are correctly excluded. The cross-link uses a descriptive anchor and a relative path.

Key Findings

  • New FAQ entry is correctly placed under the existing # FAQ heading and uses a compliant question-word heading.
  • The in-app message is quoted verbatim, which is strong for both human recognition and AI retrieval matching.
  • No internal/engineering terminology leaks into customer-facing copy; the author consciously kept the DEW / Members.csv engineering gap out of the help site.
  • Cross-link from Workspace-Workflows to the new FAQ uses descriptive anchor text and a relative link, per Cross-Linking Standards.
  • Minor: the phrase "custom approval workflow" already carries a different meaning elsewhere in Add-Approvals.md (per-member Control-plan workflows). The new entry mitigates this well, but reviewers should confirm the verbatim quote is desired over paraphrasing.
  • Note: Add-Approvals.md uses several top-level # headings (Configure Approval Workflows, Set Category and Tag approvers, etc.), which conflicts with the single-# rule — but this is pre-existing structure, not introduced by this diff, so it is not scored here.

Recommendations

  • No blocking issues. Safe to merge from a documentation-quality standpoint once a reviewer confirms behavior accuracy.
  • Optional: consider tightening the last sentence of the new FAQ entry ("Some workspaces don't have an Account Manager...") for brevity.
  • Optional: confirm the anchor slug #why-cant-i-see-the-approval-workflows-on-my-workspace resolves on a rendered HelpDot build, since that could not be verified locally.

Files Reviewed

  • docs/articles/new-expensify/workspaces/Add-Approvals.md - New FAQ entry + expanded keywords. Compliant.
  • docs/articles/new-expensify/workspaces/Workspace-Workflows.md - New note + cross-link under the download section. Compliant.

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


**Note:** Downloading requires an internet connection. If you're offline, you'll be prompted to reconnect before the download can start.

**Note:** If your workspace's approval workflow is set up and maintained by Expensify, the **Workflows** page shows the message "A custom approval workflow is enabled on this workspace" and the **More** menu is hidden, so neither **Download workflows** nor **Import workflows** is available. Reach out to your Account Manager or Concierge for the workflow details. [Learn why the approval workflows are hidden](/articles/new-expensify/workspaces/Add-Approvals#why-cant-i-see-the-approval-workflows-on-my-workspace).

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.

Naming/style: Per HELPSITE_NAMING_CONVENTIONS.md, do not wrap UI text in quotation marks. The in-app message "A custom approval workflow is enabled on this workspace" is quoted inline here, but the parallel content in Add-Approvals.md renders the same message as a blockquote (>). For consistency and to follow the convention, present the message as a blockquote rather than in double quotes.

@Kel-Expensify

Copy link
Copy Markdown
Contributor

@stephanieelliott I don't see links to review the changes?

@Kel-Expensify

Copy link
Copy Markdown
Contributor

@stephanieelliott just following up, I didn't see links to review the changes

@stephanieelliott

Copy link
Copy Markdown
Contributor

@MelvinBot, run Deploy ExpensifyHelp / build (pull request) (.github/workflows/deployExpensifyHelp.yml )

Co-authored-by: Stephanie Elliott <stephanieelliott@users.noreply.github.com>
@github-actions github-actions Bot changed the title Docs updates for E/A#100138 hidden approval workflows on externally managed workspaces [No QA] Docs updates for E/A#100138 hidden approval workflows on externally managed workspaces Sep 16, 2026
@OSBotify

Copy link
Copy Markdown
Contributor

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

Updated articles:

@MelvinBot

Copy link
Copy Markdown
Contributor Author

✅ Deploy ExpensifyHelp / build (pull request) ran and passed — run 35069379973. Preview: https://d9e68255.helpdot.pages.dev

Why it hadn't run, and how I triggered it

The original run on this branch (34115571461, 2026-09-07) was cancelled, not failed. The workflow uses a shared concurrency: group: 'pages', so a run queued behind another one gets evicted when a newer run joins the queue. Nothing about this PR's content was at fault.

My token doesn't have actions: write, so both gh run rerun and workflow_dispatch returned 403. The workflow only fires on pull_request types [opened, synchronize], so reopening the PR wouldn't have triggered it either. I pushed an empty commit (b95908c8) to the branch to fire synchronize.

One side effect: the build's "Ensure PR title has [No QA] prefix" step applies to docs-only PRs, so it renamed this PR to [No QA] Docs updates for E/A#100138 …. That's the workflow's own behavior, not something I changed.

@stephanieelliott

Copy link
Copy Markdown
Contributor

Oop, @Kel-Expensify looks like the job to generate the links didn't run! They're there now :)

@stephanieelliott

Copy link
Copy Markdown
Contributor

Consolidating to #101958 to avoid conflicts

truph01 pushed a commit to truph01/App that referenced this pull request Sep 28, 2026
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