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)
Copy public-docs/ai/llms.txt from this repository and paste it into your AI tool as project context.
The bundle contains summaries, integration steps and selected examples from the
individual guides. For complete source text, use the matching
public-docs/ai/llms-<slug>.txt file and its Canonical Reference.
Analytics and release notes are maintained as separate exports:
public-docs/ai/llms-analytics.txt and public-docs/ai/llms-changelog.txt.
Add those files when your question needs event details or version history.
Include your installed package version and target platform. Development docs can
contain explicitly Unreleased behavior; compare the Changelog
before using it. For a failing integration, include the observed symptom and the
step from Troubleshooting. Validate generated code against
the exported Flutter API and your application toolchain.
Minimal example app in this repo: packages/storyteller_sdk/example/
{"slug": "ai", "page_title": "AI", "page_url": "AI/", "canonical_url": "/flutter/AI/", "markdown": "# Using Storyteller Flutter SDK Docs with AI Assistants\n\nThis guide explains how to use Storyteller Flutter SDK documentation with AI-powered coding assistants to speed up integration and troubleshooting.\n\n## Why Use AI Assistants with Documentation\n\nAI 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:\n\n- Get code suggestions that match the Storyteller Flutter API\n- Troubleshoot integration issues faster (initialization, theming, deep links, analytics)\n- Avoid guessing platform-specific constraints (iOS vs Android)\n\n## Adding Documentation to Your Editor\n\nCopy `public-docs/ai/llms.txt` from this repository and paste it into your AI tool as project context.\n\nThe bundle contains summaries, integration steps and selected examples from the\nindividual guides. For complete source text, use the matching\n`public-docs/ai/llms-<slug>.txt` file and its Canonical Reference.\nAnalytics and release notes are maintained as separate exports:\n`public-docs/ai/llms-analytics.txt` and `public-docs/ai/llms-changelog.txt`.\nAdd those files when your question needs event details or version history.\nInclude your installed package version and target platform. Development docs can\ncontain explicitly Unreleased behavior; compare the [Changelog](Changelog.md)\nbefore using it. For a failing integration, include the observed symptom and the\nstep from [Troubleshooting](Troubleshooting.md). Validate generated code against\nthe exported Flutter API and your application toolchain.\n\n## Example Prompts\n\n1. \"Using the Storyteller Flutter SDK docs, help me initialize Storyteller in my app. Here is my `main()`.\"\n1. \"Show a minimal `StorytellerStoriesRowView` integration and how to reload data.\"\n1. \"I need to integrate deep links. Based on the docs, where should I call `Storyteller.openDeeplink(...)`?\"\n1. \"Help me customize a theme (fonts + colors) using `StorytellerTheme`.\"\n\n## Additional Resources\n\n- Showcase app entry point: https://github.com/getstoryteller/storyteller-showcase-flutter/blob/main/lib/main.dart#L11\n- Minimal example app in this repo: `packages/storyteller_sdk/example/`\n", "copy_markdown_include_header": false, "base_path": "", "ai_dir": "ai", "missing_payload_behavior": "empty"}