Shiply SDK Integration Documentation Map
This file is the remote documentation index for the shiply-sdk-integration skill. After AI assistants fetch this file via WebFetch, they access specific documents by concatenating relative paths with the full URL.
How AI Assistants Use This File
- WebFetch this file:
https://shiply.tds.qq.com/document/getting-started-guide/integration-docs-map/ - Based on the user's question, determine the target subsystem using the "Routing Decision Tree" below
- From the corresponding subsystem table, extract the full URL of the target document (
https://shiply.tds.qq.com/document/...) - WebFetch the document content using that full URL
Routing Decision Tree
Subsystem Identification
| User Question Keywords | Subsystem | Documentation Area |
|---|---|---|
| Pro edition, ShiplyPro, Pro, unified integration, one-time integration, all capabilities | ShiplyPro | ShiplyPro Integration (Recommended) |
| Configuration, switches, remote configuration, RDelivery | Configuration RDelivery | I. Remote Configuration SDK Integration |
| TAB, TAB experiments, experiments | Configuration | I. Remote Configuration SDK Integration |
| Resources, resource download, ResHub, differential | Resource ResHub | II. Remote Resource SDK Integration |
| Upgrade, gray release upgrade, in-app upgrade | In-App Upgrade | III. In-App Upgrade SDK Integration |
| Hotfix, hotfix | Hotfix | IV. Hotfix SDK Integration |
| Dynamic delivery, Flutter dynamic delivery, Kuikly, React Native hot reload, RN hot reload | Cross-Platform Dynamic Delivery | V. Cross-Platform Dynamic Delivery SDK Integration |
| General concepts, concepts, terminology, envId, systemId, update strategy | General Concepts | platform-user-guide/concepts |
| Cannot pull, not taking effect, no logs, troubleshooting | Troubleshooting | General Concepts & Troubleshooting |
Platform Identification
| User Question Keywords | Platform |
|---|---|
| iOS, iPhone, iPad | iOS |
| Android | Android |
| Harmony, ArkTS | Harmony |
| Flutter, Dart | Flutter |
| Windows, C++, Win32 | Windows |
| Kuikly | Kuikly |
| React Native, RN | React Native |
Integration Method Identification
| User Question Keywords | Integration Method | Description |
|---|---|---|
| Pro edition, ShiplyPro, Pro, unified integration, one-time integration, all capabilities | ShiplyPro | Unified initialization entry point; one-time integration of configuration, resources, in-app upgrade, and all capabilities (excluding hotfix). Recommended as the first choice. |
| Standalone integration, configuration only, resources only | On-Demand Integration | Integrate only the required subsystems |
ShiplyPro Integration (Recommended)
The ShiplyPro SDK provides a unified initialization entry point for one-time integration of remote configuration, remote resources, and in-app upgrade (excluding hotfix). We recommend integrating ShiplyPro first to avoid duplicate integration later.
| Platform | Documentation Link | Description |
|---|---|---|
| iOS | integration-ios-sdk | ShiplyPro SDK initialization and dependency setup for iOS |
| Android | integration-android-sdk | ShiplyPro SDK initialization and dependency setup for Android |
| Harmony | integration-harmony-sdk | ShiplyPro SDK initialization and dependency setup for Harmony |
Tip: If you have already integrated ShiplyPro, you only need to enable the corresponding subsystems and capabilities on the Shiply platform — no need to integrate the SDK again.
I. Remote Configuration SDK Integration (RDelivery)
Remote configuration switches, A/B experiments, and dynamic parameter delivery. Choose this path when integrating configuration capabilities separately.
| Platform | Documentation Link | Description |
|---|---|---|
| iOS | ios-sdk-integration | RDelivery configuration SDK integration for iOS |
| Android | android-sdk-integration | RDelivery configuration SDK integration for Android |
| Harmony | harmony-sdk-integration | RDelivery configuration SDK integration for Harmony |
Configuration SDK Advanced Features
| Topic | Documentation Link | Description |
|---|---|---|
| Configuration Quick Start | quick-start | Complete workflow for creating configurations, releasing, and client-side reading |
| Configuration Overview | overview | Remote configuration positioning and core concepts |
| Configuration FAQ | faq | Common configuration questions and answers |
| Configuration Templates | config-templates | Use templates to manage configuration items in bulk |
| Configuration Changelog (Android) | android-update-log | Android configuration SDK version change log |
| Configuration Changelog (iOS) | ios-update-log | iOS configuration SDK version change log |
| Configuration Changelog (Harmony) | harmony-update-log | Harmony configuration SDK version change log |
II. Remote Resource SDK Integration (ResHub)
Remote download and differential updates for resource files (images, configuration packages, models, etc.). Choose this path when integrating resource download capabilities separately.
| Platform | Documentation Link | Description |
|---|---|---|
| iOS | ios-sdk-integration | ResHub resource SDK integration for iOS |
| Android | android-sdk-integration | ResHub resource SDK integration for Android |
| Flutter | flutter-sdk-integration | ResHub resource SDK integration for Flutter |
| Harmony | harmony-sdk-integration | ResHub resource SDK integration for Harmony |
| Windows | windows-sdk-integration | ResHub resource SDK integration for Windows |
Resource SDK Advanced Features
| Topic | Documentation Link | Description |
|---|---|---|
| Resource Quick Start | quick-start | Complete workflow for uploading resources, releasing, and client-side pulling |
| Resource Overview | overview | Remote resource positioning and core concepts |
| Resource FAQ | faq | Common resource questions and answers |
| Pull Project Resources | pull-project-resource | Project-level resource pull usage guide |
| Resource Changelog (Android) | android-update-log | Android resource SDK version change log |
| Resource Changelog (iOS) | ios-update-log | iOS resource SDK version change log |
| Resource Changelog (Harmony) | harmony-update-log | Harmony resource SDK version change log |
III. In-App Upgrade SDK Integration
App version gray release upgrade and forced update dialogs. Supported on Android only.
| Platform | Documentation Link | Description |
|---|---|---|
| Android | android-sdk-integration | In-app upgrade SDK integration for Android |
Upgrade SDK Related Documentation
| Topic | Documentation Link | Description |
|---|---|---|
| Upgrade Quick Start | quick-start | Complete workflow for creating upgrade tasks, gray release, and client-side triggering |
| Upgrade Overview | overview | In-app upgrade positioning and core concepts |
| Upgrade FAQ | faq | Common upgrade questions and answers |
IV. Hotfix SDK Integration
Online bug hotfix for Android without releasing a new version. Supported on Android only; requires separate integration.
| Platform | Documentation Link | Description |
|---|---|---|
| Android | android-sdk-integration | Hotfix SDK integration for Android |
Hotfix SDK Related Documentation
| Topic | Documentation Link | Description |
|---|---|---|
| Hotfix Quick Start | quick-start | Complete workflow for releasing patches and client-side loading fixes |
| Hotfix Overview | overview | Hotfix positioning and core concepts |
| Hotfix FAQ | faq | Common hotfix questions and answers |
V. Cross-Platform Dynamic Delivery SDK Integration
Dynamic delivery capabilities for cross-platform frameworks such as Flutter dynamic delivery, Kuikly dynamic delivery, and React Native hot reload. Suitable for scenarios requiring dynamic UI or business logic updates.
| Platform/Framework | Documentation Link | Description |
|---|---|---|
| Flutter Dynamic Delivery | flutter-sdk-integration | Flutter dynamic delivery SDK integration, supporting dynamic Flutter page delivery |
| Kuikly Dynamic Delivery | kuikly-sdk-integration | Kuikly framework dynamic delivery SDK integration |
| React Native Hot Reload | rn-sdk-integration | React Native hot reload SDK integration, supporting dynamic JS Bundle delivery |
Dynamic Delivery SDK Advanced Features
| Topic | Documentation Link | Description |
|---|---|---|
| Flutter Dynamic Delivery Quick Start | quick-start | Quick start for Flutter dynamic delivery integration and usage |
| Flutter Dynamic Delivery Overview | overview | Flutter dynamic delivery positioning and core concepts |
| Flutter Dynamic Delivery FAQ | faq | Common Flutter dynamic delivery questions and answers |
| Flutter Module Integration | module-integration-doc | Detailed guide for integrating Flutter modules into native projects |
| Kuikly Dynamic Delivery Quick Start | quick-start | Quick start for Kuikly dynamic delivery integration and usage |
| Kuikly Dynamic Delivery Overview | overview | Kuikly dynamic delivery positioning and core concepts |
| React Native Hot Reload Quick Start | quick-start | Quick start for React Native hot reload integration and usage |
| React Native Hot Reload Overview | overview | React Native hot reload positioning and core concepts |
VI. Platform General Documentation (Reference)
Recommended first read: Documents marked with ⭐ "Platform Overview" are the best entry point for understanding Shiply's overall capabilities. The following documents are cross-platform shared reference content.
| Topic | Documentation Link | Description |
|---|---|---|
| ⭐ Platform Overview | platform-overview | Shiply platform introduction, feature matrix, and applicable scenarios (recommended first read) |
| Getting Started Guide | integration-process | Overall platform integration workflow and prerequisites |
| Platform User Guide | concepts | Platform core concepts: credentials, environments, update strategies, etc. |
| General FAQ | faq | Common platform questions and answers |
| Terms and Policies | terms-and-policies | Terms of service and privacy policy |
General Concepts & Troubleshooting (Cross-Platform Shared)
When you encounter concepts you don't understand or features not taking effect during integration, consult this area first.
| Topic | Documentation Link | Description |
|---|---|---|
| General Concepts and Terminology | concepts | Explanations of core concepts such as credentials, environments, update strategies, systemId, dependency injection, etc. |
| General Troubleshooting Guide | concepts | Common troubleshooting guidance covered in platform general concepts |
| Configuration Pull Troubleshooting Guide | task-pull-troubleshooting-guide | Dedicated troubleshooting workflow for configuration pull failures and ineffectiveness |