Skip to content

[No QA] Fix egencia docs - #100043

Open
rlinoz wants to merge 3 commits into
mainfrom
rodrigo-fix-egencia-doc
Open

[No QA] Fix egencia docs#100043
rlinoz wants to merge 3 commits into
mainfrom
rodrigo-fix-egencia-doc

Conversation

@rlinoz

@rlinoz rlinoz commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/677339
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 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

@rlinoz rlinoz self-assigned this Sep 1, 2026
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 1, 2026

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review Completed 2026-09-01T14:03:27.711795Z f9855cb PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.


# Enabling the Egencia Feed
A file feed is an automated data transfer from Egencia to Expensify.
# Enabling the Egencia Integration

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.

Heading violation (multiple # headings, not task-based): Only one # heading (the article title) is permitted, plus optional # FAQ — no other # headings are allowed (HELP_AUTHORING_GUIDELINES.md Sections 4 & 9). Demote this to ##. It must also be task-based, starting with an action verb or question word (Section 2). Suggested: ## How to enable the Egencia integration.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@MelvinBot can you fix this please

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.

Here's the fix for this heading:

Suggested change
# Enabling the Egencia Integration
## How to enable the Egencia integration

The same rule breaks four other headings in docs/articles/new-expensify/connections/Egencia.md, so demoting only this one still leaves the article non-compliant. The article needs exactly one # (the title) and task-based ## sections below it (Sections 2 and 4):

Line Now Change to
7 # Getting Started # How to connect Egencia to Expensify — generic headings are forbidden, and this is the one # the article gets
11 ## Requirements ## What you need to use the Egencia integration — noun-only
18 # How Egencia Works with Expensify ## How Egencia works with Expensify
25 # Enabling the Egencia Integration ## How to enable the Egencia integration
36 # Connecting a Central Purchasing Account ## How to connect a central purchasing account
39 ## Steps to Enable a Central Purchasing Account ### How to enable a central purchasing account
44 ## How It Works ### How central purchasing account receipts work

The other review bot comment also flags a missing internalScope key in the frontmatter, which Section 3 makes mandatory:

internalScope: Audience is Control Workspace admins and travelers, covers enabling the Egencia feed and central purchasing account, does not cover Egencia booking itself or other travel partners

⚠️ I can't push changes to this PR because I didn't open it and I'm not listed as an assignee. To have me make this fix, add me to the PR assignees and then retry your request.


view run

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@MelvinBot implement the changes

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.

Done — pushed as 25e86c5.

Each article now has exactly one # (the title) with task-based ## sections under it, and the mandatory internalScope key is in the frontmatter.

Was Now
# Getting Started # Connect Egencia to Expensify
## Requirements ## What you need to use the Egencia integration
# How Egencia Works with Expensify ## How Egencia works with Expensify
# Enabling the Egencia Integration ## How to enable the Egencia integration
# Connecting a Central Purchasing Account ## How to connect a central purchasing account
## Steps to Enable a Central Purchasing Account folded into the section above
## How It Works ## What happens after you connect a central purchasing account

Two things worth flagging:

  • I applied the same fix to docs/articles/expensify-classic/connections/Egencia.md. It was byte-identical to the New Expensify article and is also in this PR's diff, so leaving it would have failed the same rule on the next review pass.
  • I dropped the ### levels I suggested earlier. TEMPLATE.md says to use only # and ##, never ###, so the two sub-sections became flat ## sections instead.

Only headings and frontmatter changed — no prose was reworded.

I could not run cspell locally in this environment (the command wasn't permitted), so the spellcheck check on this push is the first real verification. The only new terms are internalScope, Admins, and routing, and internalScope already appears in TEMPLATE.md, so I don't expect a failure.

The other bot comment about description/keywords still references "travel booking receipts and expenses" and lists Expensify Classic as a keyword on the New Expensify article. I left both alone since you asked for the heading fix — say the word if you want those updated too.


view run

Comment thread docs/articles/new-expensify/connections/Egencia.md
@github-actions github-actions Bot changed the title Fix egencia docs [No QA] Fix egencia docs Sep 1, 2026
@OSBotify

This comment has been minimized.

@github-actions

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR makes a focused set of edits to docs/articles/new-expensify/connections/Egencia.md. It removes an off-topic API / Integration Server introduction that did not belong in an Egencia travel-booking article, tightens the "How Egencia Works" bullets (dropping itinerary import and the Trips section reference), and renames the "Egencia Feed" section to "Egencia Integration" with clearer wording. The changes improve topical focus and accuracy. Scores below reflect only the proposed diff, not pre-existing unchanged content.

Scores Summary

  • Readability: 8/10 - The removed API preamble was confusing and off-scope; deleting it sharpens the article. Reworded integration sentences are clear and concise. Prose flows well and steps remain scannable.
  • AI Readiness: 5/10 - Removing the unrelated NetSuite/Xero/Workday paragraph reduces multi-feature noise and improves retrieval precision. However, the changed section headings introduced/retained (Enabling the Egencia Integration, Getting Started) are still non-task-based top-level headings rather than a single title with task-based sub-headings, and the diff does not add the required internalScope metadata.
  • Style Compliance: 6/10 - Terminology stays consistent (Egencia, Control Workspace, verified Domain) and bold UI labels are preserved. But Getting Started is an explicitly forbidden generic heading, and Enabling the Egencia Integration should be task-based (e.g. How to enable the Egencia integration). The diff touched these headings without bringing them into compliance.

Key Findings

  • Positive: Removing the API/Integration Server intro and Note eliminates content that violated the single-workflow / no multi-feature rule and was inconsistent with the Egencia topic.
  • Positive: The new integration description ("automatically send flight and fee data to Expensify") is more precise than the prior generic "file feed" wording.
  • Positive: Dropping the unverifiable Trips-section bullet and itinerary claim improves accuracy.
  • Concern: The touched heading "Enabling the Egencia Integration" remains a non-task-based top-level heading. Per HELP_AUTHORING_GUIDELINES.md Sections 2 and 4, only one top-level heading (the title) is allowed and section headings must be task-based (start with How/What/Where, etc.) and demoted to sub-headings.
  • Concern: "Getting Started" (retained in the edited region) is a forbidden generic heading.
  • Concern: internalScope is still missing from the YAML frontmatter (mandatory per Section 3 and TEMPLATE.md).

Recommendations

  • Convert "Enabling the Egencia Integration" to a task-based sub-heading, e.g. "How to enable the Egencia integration".
  • Replace/remove "Getting Started"; fold the intro under the single article title.
  • Add internalScope to the frontmatter describing audience, covered workflow, and exclusions.
  • Consider collapsing the remaining top-level section headings (How Egencia Works with Expensify, Connecting a Central Purchasing Account) to task-based sub-headings so the article has exactly one title heading.

Files Reviewed

  • docs/articles/new-expensify/connections/Egencia.md - Improved focus and accuracy; heading structure and internalScope metadata still need work.

Note: This review reflects only the changes proposed in the diff.

@OSBotify

This comment has been minimized.

Demote the extra # headings to task-based ## sections so each article has
exactly one # title, replace the generic 'Getting Started' and noun-only
headings, and add the mandatory internalScope frontmatter key.

Co-authored-by: Rodrigo Lino da Costa <rlinoz@users.noreply.github.com>
@OSBotify

OSBotify commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

Updated articles:

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.

3 participants