Skip to content

Conversation

@stephanieelliott
Copy link
Contributor

Explanation of Change

Fixed Issues

$
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

  • 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 verified there are no new alerts related to the canBeMissing param for useOnyx
  • 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 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 used JaimeGPT to get English > Spanish translation. I then posted it 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 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 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.ts 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 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 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.
  • 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.
  • 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

keywords: Okta Workflows, Expensify API, user provisioning, deprovisioning, Advanced Employee Updater, automate onboarding, SSO, identity management
---

{% include docs/articles/Unlisted/Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md %}
Copy link
Contributor

Choose a reason for hiding this comment

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

AI Readiness violation: This file only contains a Jekyll include statement and no actual content. This creates problems for AI comprehension because:

  1. The content is not directly accessible - AI systems reading this file won't see the actual article content
  2. Search indexing may not work properly
  3. The file lacks the structural elements required for proper documentation (breadcrumbs, headings, body content)

Recommendation: Either:

  • Inline the full content from the included file directly into this document, OR
  • If this is meant to be a redirect/alias, consider using a different approach that maintains content visibility

keywords: Okta Workflows, Expensify API, user provisioning, deprovisioning, Advanced Employee Updater, automate onboarding, SSO, identity management
---

{% include docs/articles/Unlisted/Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md %}
Copy link
Contributor

Choose a reason for hiding this comment

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

Readability violation: The file lacks essential structural elements:

  1. Missing breadcrumb path - There should be a navigation breadcrumb below the H1 heading (e.g., "Settings > Workspaces > Integrations > Okta")
  2. No H1 heading - The title in YAML frontmatter is not the same as having an actual # Heading in the content
  3. No body content - The file only has a Jekyll include statement with no visible content

This makes the document impossible to scan or read in its current form.

@@ -0,0 +1,7 @@
---
title: Automate User Provisioning in Expensify with Okta Workflows
Copy link
Contributor

Choose a reason for hiding this comment

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

Terminology violation: The title uses "User" which should be changed to "Member" to match Expensify style standards.

Suggested fix:

title: Automate Member Provisioning in Expensify with Okta Workflows

@@ -0,0 +1,7 @@
---
title: Automate User Provisioning in Expensify with Okta Workflows
description: Set up Okta Workflows with Expensify’s API to automatically provision, update, and deprovision users.
Copy link
Contributor

Choose a reason for hiding this comment

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

Terminology violation: The description uses "users" which should be "members" to match Expensify style standards.

Suggested fix:

description: Set up Okta Workflows with Expensify's API to automatically provision, update, and deprovision members.

---
title: Automate User Provisioning in Expensify with Okta Workflows
description: Set up Okta Workflows with Expensify’s API to automatically provision, update, and deprovision users.
keywords: Okta Workflows, Expensify API, user provisioning, deprovisioning, Advanced Employee Updater, automate onboarding, SSO, identity management
Copy link
Contributor

Choose a reason for hiding this comment

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

Terminology violation: The keywords include "user provisioning" which should be "member provisioning" to match Expensify style standards.

Suggested fix:

keywords: Okta Workflows, Expensify API, member provisioning, deprovisioning, Advanced Employee Updater, automate onboarding, SSO, identity management

@github-actions
Copy link
Contributor

HelpDot Documentation Review

Overall Assessment

This PR introduces a test file (test-include.md) that attempts to use a Jekyll markdown include pattern ({% include docs/articles/Unlisted/Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md %}). However, this pattern is not supported in the Expensify Help documentation system and represents a critical architectural issue that will prevent the intended functionality from working.

Scores Summary

  • Readability: N/A - The file contains only YAML frontmatter and an include statement
  • AI Readiness: 2/10 - The YAML metadata is well-structured with appropriate title, description, and keywords, but the file has no actual content to read
  • Style Compliance: 1/10 - Uses an unsupported Jekyll pattern that doesn't exist in the codebase

Key Findings

Critical Issues:

  1. Unsupported Include Pattern: The file attempts to use {% include docs/articles/Unlisted/Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md %} to include another markdown file. After reviewing the entire documentation codebase, no markdown files use this pattern. Jekyll includes in this project only reference HTML partials from the _includes/ directory (e.g., faq-begin.md, hub.html, video.html, selector.html).

  2. Incorrect Include Path: Even if markdown includes were supported, Jekyll's {% include %} tag looks for files in the _includes/ directory by default, not in docs/articles/. The path provided would not resolve correctly.

  3. Content Duplication: The target file Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md already exists with complete, high-quality content. Creating a wrapper file defeats the purpose of having a single source of truth.

Positive Aspects:

  • The YAML frontmatter is properly structured with all required fields (title, description, keywords)
  • Keywords are comprehensive and relevant (Okta Workflows, Expensify API, user provisioning, deprovisioning, Advanced Employee Updater, automate onboarding, SSO, identity management)
  • The target article content is well-written, comprehensive, and follows HelpDot standards

Design Pattern Issues:

  • Jekyll markdown includes are not used anywhere in the 100+ documentation files reviewed
  • Existing Jekyll includes only reference HTML partials for UI components (faq-begin.md, hub.html, video.html, info.html, selector.html, etc.)
  • The documentation system expects each markdown file to be self-contained with its own content

Recommendations

Priority Actions Required:

  1. Remove this test file entirely - The include pattern will not work and serves no functional purpose

  2. If duplication is needed, consider these alternatives:

    • Use a redirect in docs/redirects.csv to point one URL to another
    • Create proper documentation structure per the README.md guidelines
    • If content needs to appear in multiple locations, coordinate with the team on a proper reusable component strategy using HTML includes
  3. If testing Jekyll functionality, test with supported patterns:

    • HTML includes: {% include hub.html %}
    • FAQ blocks: {% include faq-begin.md %} ... {% include faq-end.md %}
    • Videos: {% include video.html src="..." %}
    • Info boxes: {% include info.html %} ... {% include end-info.html %}
  4. Reference documentation standards:

    • Review /home/runner/work/App/App/docs/README.md for proper article creation
    • Use /home/runner/work/App/App/docs/TEMPLATE.md as the starting point for new articles
    • Consult existing articles for patterns that work within the system

Files Reviewed

  • docs/articles/Unlisted/test-include.md (new file) - Critical issues found, will not function as intended
  • Referenced: docs/articles/Unlisted/Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md - This file is complete and well-written; no wrapper needed

Technical Context

The Expensify Help site uses Jekyll with a specific architecture:

  • Markdown files should contain their own content
  • {% include %} statements reference HTML partials from _includes/ directory
  • No precedent exists for including one markdown file within another
  • The build process (createDocsRoutes + Jekyll build + Cloudflare deployment) expects standalone markdown articles

Recommendation: Do not merge this PR. The pattern used will not work in the current documentation system. If there's a specific use case driving this test, please clarify the goal so the team can recommend an appropriate solution that works within the existing architecture.

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: 8057317a08

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

keywords: Okta Workflows, Expensify API, user provisioning, deprovisioning, Advanced Employee Updater, automate onboarding, SSO, identity management
---

{% include docs/articles/Unlisted/Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md %}

Choose a reason for hiding this comment

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

P2 Badge Use Jekyll include from _includes or include_relative

The new article uses {% include docs/articles/Unlisted/… %}, but Jekyll’s include tag only resolves files inside docs/_includes (see docs/README.md section describing includes). Since the target Markdown file lives under docs/articles/Unlisted, the build will error with “included file not found in _includes” and this page won’t render when the docs site is generated. Consider moving the included file into _includes or switching to {% include_relative Automate-User-Provisioning-in-Expensify-with-Okta-Workflows.md %} so the include resolves correctly.

Useful? React with 👍 / 👎.

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.

2 participants