Skip to content

Using Storyteller Kotlin SDK Docs with AI Assistants#

AI coding assistants (ChatGPT, Claude, Copilot, etc.) work best when you provide both:

  1. Your app code (Gradle config, initialization code, and the UI integration point).
  2. Storyteller Kotlin SDK documentation context.

This page describes the recommended workflow.

Download llms.txt (AI Context)#

llms.txt aggregates the public docs into a single plain-text file that is easy to paste or attach to AI tools. Images are removed; headings and code examples are preserved.

  1. Share llms.txt with the AI assistant (attach or paste).
  2. Share the relevant app files/snippets:
  3. Gradle setup (settings.gradle(.kts), app build.gradle(.kts))
  4. SDK initialization (Storyteller.initialize(...))
  5. The integration surface (Compose screen / Activity / Fragment)
  6. Ask for a concrete output: a patch-style diff, a minimal snippet, or a step-by-step checklist.

Rules for AI-Generated Code (Integration Safety)#

  1. Use only Storyteller public APIs that exist in the SDK and/or are documented in these pages.
  2. Do not invent optional parameters, config flags, or DTO fields unless the prompt requires them.
  3. Do not include secrets or PII in examples; use placeholders (e.g., [APIKEY], "user-id").
  4. Prefer Jetpack Compose components unless legacy XML Views are explicitly required.
  5. When referencing behavior or configuration, prefer the canonical docs URLs:
  6. https://docs.getstoryteller.com/android/<PageName>/

Good Prompt Examples#

  • "Here is my Application and app build.gradle.kts. Add Storyteller initialization and a StorytellerStoriesRow to my Compose screen."
  • "I need to handle Storyteller deep links in MainActivity. Here is my intent handling code; update it safely."
  • "We want to disable personalization for some users. Show how to configure tracking options during initialization."