Skip to content

[no QA] Docs updates for E/A#100161 document domain admin access request review - #101002

Closed
MelvinBot wants to merge 1 commit into
mainfrom
melvin/docs-domain-admin-requests
Closed

MelvinBot wants to merge 1 commit into
mainfrom
melvin/docs-domain-admin-requests

Conversation

@MelvinBot

Copy link
Copy Markdown
Contributor

Explanation of Change

Help site follow-up to #100161, which added a Requests section to the domain Admins page so a Domain Admin can approve or deny someone who asked for admin access, and added a green dot on the Workspaces tab, the domain's row on the Domains tab, and the Domain admins menu item while a request is waiting.

The help site already documented the requester side of this flow (Ask for admin access on the Domain exists page) but had nothing on the admin side, so an admin who saw a green dot had no article explaining it.

New article — docs/articles/new-expensify/domains/Review-Domain-Admin-Requests.md

  • Who can review requests, where the green dot appears, and how to get to the Requests section.
  • Steps to Approve or Deny a request, and what happens after each.
  • FAQ covering the green dot on the Workspaces tab, adding an admin without a request, why the Requests section may not appear, re-requests after a denial, and the approve/deny error messages.

Updated — docs/articles/new-expensify/domains/Claim-and-Verify-a-Domain.md

  • "What happens after you ask for admin access" now says the request lands in a Requests section for the domain's admins, and that an admin can deny it.
  • The "Why does the domain I requested access to not show on my Domains tab?" FAQ now covers the denied case.

Updated — docs/articles/new-expensify/domains/Domain-Admins.md

  • Cross-link to the new article.
  • Corrected the menu item reference from Domain Admins to Domain admins to match the label in the product.

Written against docs/HELPSITE_NAMING_CONVENTIONS.md, docs/HELP_AUTHORING_GUIDELINES.md, and docs/TEMPLATE.md. UI labels were taken from src/languages/en.ts on the merged branch: Requests, Approve, Deny, Admins, Add admin, Domain admins. The Domains tab label and its empty state were confirmed against the live web app; the Domain admins page itself could not be opened because the test account has no domain, so please confirm the on-screen labels there.

Fixed Issues

$ #99383
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

N/A — documentation only.

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

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

Co-authored-by: Jakub Steć <jakubstec@users.noreply.github.com>
@MelvinBot
MelvinBot requested a review from a team September 11, 2026 22:07
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label Sep 11, 2026
@jakubstec

Copy link
Copy Markdown
Member

@MelvinBot mark this PR as ready for review

@MelvinBot
MelvinBot marked this pull request as ready for review September 14, 2026 15:21
@melvin-bot

melvin-bot Bot commented Sep 14, 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 @brianlee-expensify

@MelvinBot

MelvinBot commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor Author

🤖 Done — this PR is out of draft and ready for review.

  • Expensify/pullerbear and stephanieelliott are requested as reviewers.
  • The only failing check is Check independent approval, which clears once a reviewer approves.

One thing left for you: the Tests and QA Steps sections still hold the // TODO: placeholders. I won't fill those in on your behalf — please replace them (and tick the author checklist) so the reviewer knows what you verified.


view run · no recording available

@melvin-bot
melvin-bot Bot requested review from brianlee-expensify and removed request for a team September 14, 2026 15:22
@melvin-bot

melvin-bot Bot commented Sep 14, 2026

Copy link
Copy Markdown

@brianlee-expensify 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]

@github-actions

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment
This PR adds a new article (Review-Domain-Admin-Requests.md) documenting the Domain Admin side of the access-request flow and updates two existing articles (Claim-and-Verify-a-Domain.md, Domain-Admins.md) to reflect the new approve/deny behavior and correct a UI label. The changes are well-scoped, consistent, and closely follow the governance specs.

Scores Summary

  • Readability: 9/10 - Clear, scannable prose. Numbered steps are sequential and action-oriented; explanatory bullets are concise and benefit-focused.
  • AI Readiness: 9/10 - Correct YAML frontmatter with strong internalScope on all files, single top-level title plus exempt FAQ, task-based section headings (Who/How/What/Why), and full feature names throughout. Keyword lists reflect real search intent.
  • Style Compliance: 9/10 - Exact UI labels bolded (Requests, Approve, Deny, Admins, Add admin, Domain admins), correct unified navigation phrasing, and the 'Domain Admins' to 'Domain admins' menu-item correction aligns docs with the product label.

Key Findings

  • New article is single-workflow, uses only allowed heading levels, and every content heading is task-based per Section 2. Screenshot placeholders use the exact HTML-comment format with specific, confusion-preventing Purpose statements.
  • Cross-links are bidirectional, use descriptive anchor text, use relative links, and sit in explanatory sentences rather than inside numbered steps - fully compliant with Section 7.
  • Error-message FAQ quotes the exact product strings and documents offline-queue behavior, a nice retrieval win.
  • The internalScope exclusions were updated on both existing articles to hand off cleanly to the new article, avoiding scope overlap.

Recommendations

  • Confirm the on-screen labels on the Domain admins page (Requests / Admins section headers, Approve / Deny buttons) against the live product, as the PR notes the test account could not open that page.
  • Minor: verify the green-dot description ordering (Workspaces tab / Domains row / Domain admins menu item) matches the actual product surfacing order.

Files Reviewed

  • Review-Domain-Admin-Requests.md - New, compliant, ready pending label verification.
  • Claim-and-Verify-a-Domain.md - Updated approve/deny wording and FAQ; consistent and accurate.
  • Domain-Admins.md - Label correction and cross-link added; correct.

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

@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: 4afee2763c

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

## What happens after you approve or deny a Domain Admin request

- If you approve the request, the person moves out of the **Requests** section and into the **Admins** section with full Domain Admin access.
- If you deny the request, the row disappears from the **Requests** section and the person is not added as a Domain Admin.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Document the pending row for offline denials

When an admin selects Deny while offline, the row does not disappear as stated here: declineDomainAdminshipRequest deliberately retains the requester with a pending DELETE, and shouldShowPendingRow keeps that row visible while offline until the queued request succeeds after reconnection. Since the FAQ explicitly tells users that offline actions are queued, qualify this outcome so they do not interpret the still-visible, disabled row as a failed denial.

Useful? React with 👍 / 👎.

@stephanieelliott stephanieelliott changed the title Docs updates for E/A#100161 document domain admin access request review [no QA] Docs updates for E/A#100161 document domain admin access request review Sep 22, 2026
@stephanieelliott

Copy link
Copy Markdown
Contributor

Covering this in: #101951

pull Bot pushed a commit to AmirulAndalib/App-1 that referenced this pull request Sep 25, 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.

3 participants