feat(docs): add advanced guides #4881
Open
+937
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
|
@khaliqgant I won't have time for a full review today, I think, but see some things that will need tweaks (e.g. nav structure). Please hold off from merging, thanks! |
Member
Author
Got it. No problem! The content is mostly unchanged from the integration templates fwiw |
TBonnin
approved these changes
Oct 20, 2025
Contributor
|
This PR is stale because it has been open for 30 days with no activity. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Advanced Integration Pattern Guides to Documentation
This pull request introduces a new 'Advanced Integration Patterns' section to the documentation by adding six comprehensive implementation guides which cover advanced sync/action use cases. The new guides-
configuration-based-sync,selection-based-sync,window-time-based-sync,action-leveraging-sync-responses,24-hour-extended-sync, andmulti-model-sync-are provided as individual.mdxfiles detailing best practices, code patterns, edge cases, and pitfalls for each scenario. Additionally, necessary updates are made todocs.jsonto organize and surface these new guides within the sidebar navigation structure.Key Changes
• Added
docs/implementation-guides/building-integrations/configuration-based-sync.mdxexplaining custom syncs using metadata-driven configuration.• Added
docs/implementation-guides/building-integrations/selection-based-sync.mdxdescribing user-defined resource selection sync pattern.• Added
docs/implementation-guides/building-integrations/window-time-based-sync.mdxfor time-windowed batch data ingestion.• Added
docs/implementation-guides/building-integrations/action-leveraging-sync-responses.mdxcovering actions that utilize synced data.• Added
docs/implementation-guides/building-integrations/24-hour-extended-sync.mdxdocumenting approach for long-running, resumable syncs under execution limits.• Added
docs/implementation-guides/building-integrations/multi-model-sync.mdxshowing multi-entity synchronization pattern.• Updated
docs/docs.jsonto introduce an 'Advanced Integration Patterns' group referencing all new pattern guides.Affected Areas
• docs/implementation-guides/building-integrations/configuration-based-sync.mdx
• docs/implementation-guides/building-integrations/selection-based-sync.mdx
• docs/implementation-guides/building-integrations/window-time-based-sync.mdx
• docs/implementation-guides/building-integrations/action-leveraging-sync-responses.mdx
• docs/implementation-guides/building-integrations/24-hour-extended-sync.mdx
• docs/implementation-guides/building-integrations/multi-model-sync.mdx
• docs/docs.json
This summary was automatically generated by @propel-code-bot