Skip to content

docs: sync immediatelyExecute documentation with schema clarification#215

Open
claude[bot] wants to merge 1 commit intomainfrom
docs/sync-20260220
Open

docs: sync immediatelyExecute documentation with schema clarification#215
claude[bot] wants to merge 1 commit intomainfrom
docs/sync-20260220

Conversation

@claude
Copy link

@claude claude bot commented Feb 20, 2026

Summary

  • Add Info note in quote-system.mdx explaining immediatelyExecute source type requirements
  • Fix fiat-crypto-conversion.mdx example to use internal account source (was incorrectly using customerId source which is incompatible with immediatelyExecute)
  • Add Info note in fiat-crypto-conversion.mdx about source requirements

Context

Schema clarification was added in f3325bf stating that immediatelyExecute can only be used for quotes with a source that is either:

  • An internal account, OR
  • An external account with direct pull functionality (e.g., ACH pull)

This PR syncs the Mintlify documentation with that schema change.

Test plan

  • Verify quote-system.mdx renders correctly with the new Info block
  • Verify fiat-crypto-conversion.mdx example is syntactically correct
  • Verify Info blocks display properly in Mintlify preview

🤖 Generated with Claude Code

Update documentation to reflect the schema clarification added in f3325bf
that immediatelyExecute can only be used with internal account sources or
external accounts with direct pull functionality.

- Add Info note in quote-system.mdx explaining source type requirements
- Fix fiat-crypto-conversion.mdx example to use internal account source
  (was incorrectly using customerId source which is incompatible)
- Add Info note in fiat-crypto-conversion.mdx about source requirements

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 20, 2026

Greptile Summary

This PR syncs the Mintlify documentation with the schema clarification from f3325bf. The changes correctly document that immediatelyExecute can only be used with sources that are either internal accounts or external accounts with direct pull functionality.

Key changes:

  • Fixed fiat-crypto-conversion.mdx example that was incorrectly using customerId source (incompatible with immediatelyExecute)
  • Changed example to use proper internal account source with sourceType: "ACCOUNT" and accountId
  • Added Info blocks in both files clarifying the source type requirements
  • Properly formatted with backticks to prevent platform interpretation of @ symbols

The updated example now matches the pattern used consistently across other documentation files (rewards/quickstart.mdx, rewards/platform-tools/sandbox-testing.mdx, etc.).

Confidence Score: 5/5

  • This PR is safe to merge - documentation-only changes with proper formatting
  • Documentation changes correctly sync with schema update. The fixed example prevents user confusion by showing the correct source type for immediatelyExecute. All formatting follows Mintlify standards with proper backtick usage.
  • No files require special attention

Important Files Changed

Filename Overview
mintlify/platform-overview/core-concepts/quote-system.mdx Added Info block clarifying immediatelyExecute source requirements - matches schema documentation
mintlify/ramps/conversion-flows/fiat-crypto-conversion.mdx Fixed example to use internal account source (previously used incompatible customerId source) and added Info block

Last reviewed commit: b9655af

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.

0 participants

Comments