Skip to content

Using Storyteller Flutter SDK Docs with AI Assistants#

This guide explains how to use Storyteller Flutter SDK documentation with AI-powered coding assistants to speed up integration and troubleshooting.

Why Use AI Assistants with Documentation#

AI coding assistants (GitHub Copilot, Claude, Codex, Cursor, etc.) work best when they have the exact SDK docs and API surface in context. Providing the Storyteller docs can help you:

  • Get code suggestions that match the Storyteller Flutter API
  • Troubleshoot integration issues faster (initialization, theming, deep links, analytics)
  • Avoid guessing platform-specific constraints (iOS vs Android)

Adding Documentation to Your Editor#

Copy public-docs/ai/llms.txt from this repository and paste it into your AI tool as project context.

Example Prompts#

  1. "Using the Storyteller Flutter SDK docs, help me initialize Storyteller in my app. Here is my main()."
  2. "Show a minimal StorytellerStoriesRowView integration and how to reload data."
  3. "I need to integrate deep links. Based on the docs, where should I call Storyteller.openDeeplink(...)?"
  4. "Help me customize a theme (fonts + colors) using StorytellerTheme."

Additional Resources#

  • Showcase app entry point: https://github.com/getstoryteller/storyteller-showcase-flutter/blob/main/lib/main.dart#L7
  • Minimal example app in this repo: packages/storyteller_sdk/example/