Skip to content

[No QA] Docs updates for E/A#90359 Add Update credentials for Sage Intacct#91653

Open
MelvinBot wants to merge 4 commits into
mainfrom
melvin-docs-update-sage-intacct-credentials-90359
Open

[No QA] Docs updates for E/A#90359 Add Update credentials for Sage Intacct#91653
MelvinBot wants to merge 4 commits into
mainfrom
melvin-docs-update-sage-intacct-credentials-90359

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Summary

  • Adds FAQ entry to Connect-to-Sage-Intacct.md explaining how to update Web Services credentials via the three-dot menu
  • Adds FAQ entry to Sage-Intacct-FAQ.md with detailed steps for proactively updating Sage Intacct credentials
  • Updates internalScope metadata in the FAQ article to reflect the new credential update coverage

These docs changes reflect the new Update credentials option added to the Sage Intacct overflow menu in #90359.

Test plan

  • Verify the new FAQ entries render correctly on the help site
  • Confirm the navigation steps match the current UI (three dots menu shows Update credentials for Sage Intacct)
  • Confirm existing FAQ entries are unaffected

@abzokhattab, please review the files changed and confirm they reflect the current behavior. Then mark this PR Ready for review.

Add documentation for the new Update credentials option in the
Sage Intacct overflow menu, covering both the Connect article FAQ
and the Sage Intacct FAQ troubleshooting article.

Co-authored-by: Abdelrahman Khattab <abzokhattab@users.noreply.github.com>
@MelvinBot MelvinBot added the HelpDot Apply this label if the issue relates to ExpensifyHelp label May 25, 2026
@github-actions github-actions Bot changed the title Docs updates for E/A#90359 Add Update credentials for Sage Intacct [No QA] Docs updates for E/A#90359 Add Update credentials for Sage Intacct May 25, 2026
@OSBotify

This comment has been minimized.

@stephanieelliott stephanieelliott marked this pull request as ready for review May 27, 2026 05:26
@stephanieelliott stephanieelliott self-requested a review as a code owner May 27, 2026 05:26
@OSBotify

This comment has been minimized.

@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds credential-update FAQ entries to two Sage Intacct documentation files and updates the internalScope metadata accordingly. The changes are focused and well-scoped. There are a few consistency and compliance issues between the two files that should be addressed before merging.

Scores Summary

  • Readability: 8/10 - Steps are clear, sequential, and action-oriented. Both entries are concise and easy to follow. Minor inconsistency in how much context is given in navigation instructions across the two files.
  • AI Readiness: 8/10 - Headings are question-based and include the feature name ("Sage Intacct"). The internalScope update in the FAQ file correctly reflects the new coverage. Both entries are retrievable by realistic search queries.
  • Style Compliance: 6/10 - Several naming convention and consistency issues exist between the two added sections (detailed below).

Key Findings

Issues to address:

  1. Navigation path inconsistency between files. In Connect-to-Sage-Intacct.md, step 1 uses the full navigation instruction: "from the navigation tabs (on the left on web, and at the bottom on mobile), go to Workspaces > [Workspace Name] > Accounting". In Sage-Intacct-FAQ.md, step 1 uses only "Go to Workspace > [Workspace Name] > Accounting" with no navigation tab context. Per HELPSITE_NAMING_CONVENTIONS.md (Navigation Instruction Standards), navigation tab instructions should be included when guiding users to a destination.

  2. "Workspace" vs "Workspaces" mismatch. Sage-Intacct-FAQ.md uses "Workspace" (singular) in the navigation path, while Connect-to-Sage-Intacct.md uses "Workspaces" (plural). Per the naming conventions, the exact UI label must be used. The navigation tab is Workspaces (plural). The FAQ file should be corrected to match.

  3. Heading capitalization inconsistency. Connect-to-Sage-Intacct.md uses sentence case: "How do I update my Sage Intacct credentials?" while Sage-Intacct-FAQ.md uses Title Case: "How Do I Update My Sage Intacct Credentials?" While the FAQ file is internally consistent with its other headings (which also use Title Case), the two new additions across files should ideally follow the same convention. Sentence case is the standard per authoring guidelines.

  4. Minor navigation phrasing. In Connect-to-Sage-Intacct.md, the unified navigation instruction reads "on the left on web, and at the bottom on mobile". The governance template uses "on the left on web, on the bottom on mobile" (without "and" and using "on" rather than "at"). This is minor but worth aligning for deterministic writing.

Positive aspects:

  • Three dots menu formatting is correct in both files: "the three dots (⋮)" per governance rules.
  • Button names are properly bolded: Update credentials, Confirm.
  • The internalScope metadata update in the FAQ file accurately reflects the new content coverage.
  • FAQ headings are question-based and include the feature name, supporting AI retrieval.
  • Steps are sequential, action-oriented, and follow the UI flow.

Recommendations

  1. Align the navigation path in Sage-Intacct-FAQ.md to include the navigation tabs instruction and use "Workspaces" (plural) to match the UI and the other file.
  2. Standardize heading capitalization across both new entries. Prefer sentence case to match Connect-to-Sage-Intacct.md style, though note the existing FAQ file uses Title Case throughout -- a broader cleanup may be warranted separately.
  3. Adjust the "and at the bottom" phrasing in Connect-to-Sage-Intacct.md to "on the bottom on mobile" per the governance template.

Files Reviewed

  • docs/articles/new-expensify/connections/sage-intacct/Connect-to-Sage-Intacct.md - New FAQ entry added; mostly compliant, minor navigation phrasing issue.
  • docs/articles/new-expensify/connections/sage-intacct/Troubleshooting/Sage-Intacct-FAQ.md - New FAQ entry added and internalScope updated; navigation path and capitalization need alignment.

Note: This review covers only the proposed changes in the PR diff, not unchanged portions of these files.

Comment thread docs/articles/new-expensify/connections/sage-intacct/Connect-to-Sage-Intacct.md Outdated
Comment thread docs/articles/new-expensify/connections/sage-intacct/Connect-to-Sage-Intacct.md Outdated
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
@OSBotify

This comment has been minimized.


If you need to update your Web Services credentials (for example, after a password rotation):

1. In Expensify, from the navigation tabs (on the left on web, and at the bottom on mobile), go to **Workspaces > [Workspace Name] > Accounting**
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.

Navigation phrasing violation: The standard phrasing per HELPSITE_NAMING_CONVENTIONS.md is "In the navigation tabs (on the left on web, on the bottom on mobile)" -- do not prefix with "In Expensify, from". Also, the conjunction should be "on the bottom" not "at the bottom".

Additionally, bold formatting violation: Each navigation element should be bolded separately: **Workspaces** > **[Workspace Name]** > **Accounting** rather than as a single bolded block.

Suggested change
1. In Expensify, from the navigation tabs (on the left on web, and at the bottom on mobile), go to **Workspaces > [Workspace Name] > Accounting**
1. In the navigation tabs (on the left on web, on the bottom on mobile), go to **Workspaces** > **[Workspace Name]** > **Accounting**.

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.

Applied in 0bcdfde.

If you need to update your Web Services credentials (for example, after a password rotation):

1. In Expensify, from the navigation tabs (on the left on web, and at the bottom on mobile), go to **Workspaces > [Workspace Name] > Accounting**
2. Click the three dots **(⋮)** next to the Sage Intacct connection.
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.

Three dots menu violation: Per HELPSITE_NAMING_CONVENTIONS.md, the canonical phrasing is "Select the three dots (⋮)" -- use "Select" instead of "Click". "Click the three dots" is also listed under Prohibited Language.

Suggested change
2. Click the three dots **(⋮)** next to the Sage Intacct connection.
2. Select the three dots **(⋮)** next to the Sage Intacct connection.

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.

Applied in 0bcdfde.


1. In Expensify, from the navigation tabs (on the left on web, and at the bottom on mobile), go to **Workspaces > [Workspace Name] > Accounting**
2. Click the three dots **(⋮)** next to the Sage Intacct connection.
3. Click **Update credentials**
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.

Missing period: Steps should end with periods for consistency in formatting.

Suggested change
3. Click **Update credentials**
3. Click **Update credentials**.

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.

Applied in 0bcdfde.

1. In Expensify, from the navigation tabs (on the left on web, and at the bottom on mobile), go to **Workspaces > [Workspace Name] > Accounting**
2. Click the three dots **(⋮)** next to the Sage Intacct connection.
3. Click **Update credentials**
4. Enter your updated Web Services user credentials
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.

Missing period: Steps should end with periods for formatting consistency.

Suggested change
4. Enter your updated Web Services user credentials
4. Enter your updated Web Services user credentials.

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.

Applied in 0bcdfde.

2. Click the three dots **(⋮)** next to the Sage Intacct connection.
3. Click **Update credentials**
4. Enter your updated Web Services user credentials
5. Click **Confirm**
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.

Missing period: Steps should end with periods for formatting consistency.

Suggested change
5. Click **Confirm**
5. Click **Confirm**.

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.

Applied in 0bcdfde.

Sage Intacct uses Web Services credentials (company ID, user ID, and password) that may need to be updated periodically. You can proactively update your credentials at any time.

1. In the navigation tabs (on the left on web, on the bottom on mobile), go to **Workspaces** > **[Workspace Name]** > **Accounting**.
2. Click the three dots **(⋮)** next to the Sage Intacct connection.
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.

Three dots menu violation: Per HELPSITE_NAMING_CONVENTIONS.md, the canonical phrasing is "Select the three dots (⋮)" -- use "Select" instead of "Click". "Click the three dots" is also listed under Prohibited Language.

Suggested change
2. Click the three dots **(⋮)** next to the Sage Intacct connection.
2. Select the three dots **(⋮)** next to the Sage Intacct connection.

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.

Applied in 0bcdfde.

Comment on lines +185 to +193
## How do I update my Sage Intacct credentials?

If you need to update your Web Services credentials (for example, after a password rotation):

1. In Expensify, from the navigation tabs (on the left on web, and at the bottom on mobile), go to **Workspaces > [Workspace Name] > Accounting**
2. Click the three dots **(⋮)** next to the Sage Intacct connection.
3. Click **Update credentials**
4. Enter your updated Web Services user credentials
5. Click **Confirm**
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.

Duplicate content: These credential update instructions are duplicated nearly verbatim in docs/articles/new-expensify/connections/sage-intacct/Troubleshooting/Sage-Intacct-FAQ.md. Per HELP_AUTHORING_GUIDELINES.md (Section 7 -- Cross-Linking Standards), related content should be cross-linked rather than duplicated. Consider keeping the full instructions in one location and linking to it from the other.

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.

Skipped — this is a structural change (consolidating the duplicate steps into one canonical location with a cross-link) rather than a minor style fix, so leaving it to Krishna2323 to decide whether to refactor. Happy to follow up if you'd like me to consolidate.

@github-actions
Copy link
Copy Markdown
Contributor

HelpDot Documentation Review

Overall Assessment

This PR adds instructions for updating Sage Intacct Web Services credentials in two locations: the main Connect-to-Sage-Intacct article (as an FAQ entry) and the dedicated Sage-Intacct-FAQ troubleshooting article. The FAQ file also receives a metadata update to reflect the new content. The instructions are clear and procedurally sound, but there are several consistency and compliance issues between the two versions that should be addressed.

Scores Summary

  • Readability: 7/10 - Steps are clear and action-oriented. Minor inconsistencies in punctuation and phrasing between the two files reduce polish.
  • AI Readiness: 8/10 - Headings are task-based and searchable. The internalScope update in the FAQ file is a positive addition. Both files use the feature name in headings.
  • Style Compliance: 6/10 - Several deviations from the naming conventions, particularly around navigation phrasing and formatting consistency between the two files.

Key Findings

Issues to address:

  1. Navigation phrasing deviation (Connect-to-Sage-Intacct.md, step 1): The added text reads "In Expensify, from the navigation tabs (on the left on web, and at the bottom on mobile)". Per HELPSITE_NAMING_CONVENTIONS.md, the standard unified phrasing is: "In the navigation tabs (on the left on web, on the bottom on mobile)." The prefix "In Expensify, from" is non-standard, and the extra "and" before "at the bottom" does not match the prescribed format. The FAQ file gets this correct.

  2. Bold formatting inconsistency (Connect-to-Sage-Intacct.md, step 1): The navigation path uses a single bold block: **Workspaces > [Workspace Name] > Accounting**. The FAQ file correctly bolds each element individually: **Workspaces** > **[Workspace Name]** > **Accounting**. The individually-bolded format is the correct approach per the button and tab naming standards.

  3. Missing terminal punctuation (Connect-to-Sage-Intacct.md, steps 2-5): Steps 2 through 5 lack terminal periods. The FAQ file correctly includes periods on all steps. All steps should end with periods for consistency and professionalism.

  4. Duplicate content across files: The credential update instructions are nearly identical in both files. Per HELP_AUTHORING_GUIDELINES.md Section 1, each article should solve one primary workflow, and Section 7 (Cross-Linking Standards) recommends linking to related content rather than duplicating it. Consider keeping the full instructions in one location (the FAQ file is the natural home) and cross-linking from the other with a brief sentence and a relative link.

  5. Heading capitalization: The Connect-to-Sage-Intacct.md file uses sentence case ("How do I update my Sage Intacct credentials?") while the FAQ file uses Title Case ("How Do I Update My Sage Intacct Credentials?"). Both are internally consistent with their respective files' existing heading conventions, so this is acceptable. No action needed here.

Positive aspects:

  • The internalScope metadata update in the FAQ file correctly reflects the new content being added.
  • Both versions include the three dots symbol in the correct format with (⋮) as required.
  • Steps are sequential, action-oriented, and aligned with actual UI flow.
  • Headings are task-based and include the feature name, which supports AI retrieval.

Recommendations

  1. [Priority] Fix navigation phrasing in Connect-to-Sage-Intacct.md to match the standard: "In the navigation tabs (on the left on web, on the bottom on mobile)".
  2. [Priority] Fix bold formatting in Connect-to-Sage-Intacct.md step 1 to individually bold each path element.
  3. [Priority] Add terminal periods to all steps in Connect-to-Sage-Intacct.md.
  4. [Suggested] Consolidate duplicate content. Keep the full procedural steps in one file (preferably Sage-Intacct-FAQ.md) and replace the other with a brief mention and a cross-link, following the Cross-Linking Standards.

Files Reviewed

  • docs/articles/new-expensify/connections/sage-intacct/Connect-to-Sage-Intacct.md - New FAQ entry added; has navigation phrasing, bold formatting, and punctuation issues.
  • docs/articles/new-expensify/connections/sage-intacct/Troubleshooting/Sage-Intacct-FAQ.md - New FAQ section and metadata update; well-formatted and compliant.

Review based on governance files: HELPSITE_NAMING_CONVENTIONS.md, HELP_AUTHORING_GUIDELINES.md, and TEMPLATE.md.

@abzokhattab
Copy link
Copy Markdown
Contributor

@Krishna2323 can you please take a look at this ... its related to this PR #90359

@abzokhattab
Copy link
Copy Markdown
Contributor

@MelvinBot unassign me and assign @Krishna2323 instead

@Krishna2323
Copy link
Copy Markdown
Contributor

Krishna2323 commented May 31, 2026

@MelvinBot there are some minor suggestions above from github-actions, please resolve.

… wording, missing periods

Co-authored-by: Krishna <Krishna2323@users.noreply.github.com>
@OSBotify
Copy link
Copy Markdown
Contributor

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