Skip to content

[No QA] Update Verify-a-Domain.md#77168

Merged
mountiny merged 6 commits into
mainfrom
clarajones-expensify-patch-2
Dec 16, 2025
Merged

[No QA] Update Verify-a-Domain.md#77168
mountiny merged 6 commits into
mainfrom
clarajones-expensify-patch-2

Conversation

@clarajones-expensify

@clarajones-expensify clarajones-expensify commented Dec 9, 2025

Copy link
Copy Markdown
Contributor

Updating the documentation to reflect the last release in Release 4 of the Domains & SAML in newdot project.

Explanation of Change

Fixed Issues

$ #69195
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

// TODO: These must be filled out, or the issue title must include "[No QA]."

  • Verify that no errors appear in the JS console

PR Author Checklist

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 / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • 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 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 the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • 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
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • 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 approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • 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 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)
  • 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.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • 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
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • 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(themeColors.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 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.
  • 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 author checklist, including those that don't apply to this PR.

Screenshots/Videos

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

Updating the documentation to reflect the last release in Release 4 of the Domains & SAML in newdot project.
@clarajones-expensify clarajones-expensify self-assigned this Dec 9, 2025
@clarajones-expensify clarajones-expensify requested a review from a team as a code owner December 9, 2025 18:43
@melvin-bot

melvin-bot Bot commented Dec 9, 2025

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

@melvin-bot

melvin-bot Bot commented Dec 9, 2025

Copy link
Copy Markdown

@ZhenjaHorbach @RachCHopkins 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]

@melvin-bot melvin-bot Bot removed the request for review from a team December 9, 2025 18:43
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md
@github-actions

github-actions Bot commented Dec 9, 2025

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR consolidates domain verification documentation by replacing the brief "Verify-a-Domain.md" with a comprehensive "Claim-and-Verify-a-Domain.md" guide. The new documentation provides significantly improved coverage of the domain claiming and verification workflow, reflecting Release 4 of the Domains & SAML project. The article is well-structured with clear sections, helpful context, and logical progression through the claiming and verification process.

Scores Summary

  • Readability: 7/10 - Clear structure and mostly accessible language, but some areas need refinement for grammar, consistency, and flow
  • AI Readiness: 8/10 - Strong YAML metadata and descriptive headings with good context, though some sections could use clearer feature references
  • Style Compliance: 6/10 - Generally follows Expensify documentation patterns but has several formatting and structural inconsistencies that need correction

Key Findings

Strengths:

  • Comprehensive coverage of both claiming and verification workflows
  • Excellent use of contextual information (e.g., "What you can do with a claimed domain")
  • Strong YAML metadata with appropriate keywords for SEO and AI discovery
  • Clear step-by-step instructions with proper navigation paths
  • Good use of expected outcomes and error states

Areas for Improvement:

  1. Formatting inconsistencies: Mixed use of numbered lists and lettered sub-steps (e.g., "2. Click Enable button. a. If you have...") - should use consistent numbering or bullet points
  2. Heading hierarchy: Uses single # for all main sections instead of progressive hierarchy (# and ##) as shown in other workspace documentation
  3. Terminology alignment: Missing the opening div wrapper and "New Expensify" platform identifier that appears in other articles
  4. FAQ structure: Document does not include the standard FAQ section used in similar articles like Set-Up-SAML-Single-Sign-On.md
  5. Grammar and clarity: Several sentences need refinement (e.g., "Once verified, you'll see a confirmation message" appears twice in different contexts)

Recommendations

Priority Actions:

  1. Add the standard opening div wrapper for platform consistency
  2. Fix the mixed numbering in step 2 under "Steps to claim your domain" - either make item 'a' a proper sub-step or renumber items 3-5
  3. Implement proper heading hierarchy (use ## for subsections under main # headings)
  4. Consider adding an FAQ section to address common questions like "What if someone else already claimed my domain?" or "How long does DNS verification take?"
  5. Add visual aids (screenshots) showing the domains interface, verification status, or overflow menu - the Managing-Workspace-Members.md article demonstrates good use of screenshots

Style Improvements:

  • Replace "three-dot menu" with "overflow menu" for consistency with Expensify terminology
  • Ensure all UI element names match exact button/menu labels in the product
  • Add consistent spacing between sections (blank line before each new # heading)

Content Enhancements:

  • Expand "What happens next?" section with more specific guidance for coordination scenarios
  • Add a note about DNS propagation time (typically 24-72 hours) in the verification section
  • Consider adding a troubleshooting subsection for common DNS verification issues

Files Reviewed

  • docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md (New, 68 lines added) - Comprehensive new guide covering claiming and verification workflows. Strong content foundation with formatting and structural improvements needed.
  • docs/articles/new-expensify/workspaces/Verify-a-Domain.md (Deleted, 20 lines) - Removed in favor of the more comprehensive combined guide.

Overall Recommendation: Approve with revisions. The content quality is strong and the consolidation improves user experience, but formatting and structural consistency should be addressed before merge to align with HelpDot standards.

@github-actions github-actions Bot changed the title Update Verify-a-Domain.md [No QA] Update Verify-a-Domain.md Dec 9, 2025
@OSBotify

OSBotify commented Dec 9, 2025

Copy link
Copy Markdown
Contributor

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

Updated articles:

Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
@clarajones-expensify

Copy link
Copy Markdown
Contributor Author

Thank you @RachCHopkins for the very thorough review! Ive made the changes and a new commit

@mountiny mountiny self-requested a review December 9, 2025 23:41
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md
@RachCHopkins

Copy link
Copy Markdown
Contributor

@clarajones-expensify I have no idea - are they modals that link to a help doc? @ZhenjaHorbach @mountiny do you know how to deciper those PRs?

@mountiny mountiny requested a review from NikkiWines December 12, 2025 19:12
mountiny
mountiny previously approved these changes Dec 12, 2025
@mountiny

Copy link
Copy Markdown
Contributor

Ah seems like you need to update the redirects:

Articles have been renamed or deleted. Please add a redirect link for the old article links in redirects.csv

@ZhenjaHorbach

Copy link
Copy Markdown
Contributor

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

@melvin-bot

melvin-bot Bot commented Dec 12, 2025

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

@melvin-bot

melvin-bot Bot commented Dec 12, 2025

Copy link
Copy Markdown

@chuckdries @twisterdotcom 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]

NOTE: It looks like docs/redirects.csv was modified in this PR. Please see this SO for special instructions on how to review changes to that file.

Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
@clarajones-expensify

Copy link
Copy Markdown
Contributor Author

thank you @chuckdries for the comments! i've addressed them and pushed a new commit

Comment thread docs/articles/new-expensify/workspaces/Claim-and-Verify-a-Domain.md Outdated
@mountiny mountiny merged commit bd5ce7a into main Dec 16, 2025
14 checks passed
@mountiny mountiny deleted the clarajones-expensify-patch-2 branch December 16, 2025 19:45
@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.2.79-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to staging by https://github.com/mountiny in version: 9.2.81-0 🚀

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

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.2.81-5 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 web 🕸 success ✅
🤖 android 🤖 failure ❌
🍎 iOS 🍎 success ✅

@OSBotify

Copy link
Copy Markdown
Contributor

🚀 Deployed to production by https://github.com/AndrewGable in version: 9.2.81-5 🚀

platform result
🖥 desktop 🖥 success ✅
🕸 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.

6 participants