Guidely documentation
How the platform fits together, the management and SDK APIs, and how to install the SDK in your application.
Get started
Guidely user guideCreate, target and publish in-app guides, and measure how they perform.SDK installation & integrationInstall the SDK in React, Next.js, Svelte, SvelteKit or plain JavaScript, identify users and track events.Guide authoring, targeting, and publishingGuide kinds, the visual element picker, targeting rules, triggers and publishing.Scout: AI support messengerScout, the AI support messenger: knowledge base, handoff to your team and the Inbox.AnalyticsThe event schema and how every dashboard metric is computed.TroubleshootingFixes for guides that don't show, picker connection problems and API errors.
Reference
Guidely API referenceManagement and SDK REST endpoints under /api/v1.Environment variablesEvery environment variable the server and worker read.Security & privacyAuthentication, sessions, data handling and Scout's AI safeguards.SDK versioning and upgradesPackage versioning, API compatibility and how to upgrade.
Self-hosting
DeploymentRun the container, database and worker anywhere.Deploying Guidely on AWSDeploy to AWS with the bundled CDK app: ECS Fargate, RDS and GitHub sign-in.Guidely architectureHow the dashboard, API, worker and SDK packages fit together.Data modelThe main database tables and what they hold.Local developmentRun Guidely locally and work on the codebase.