Skip to content

Using Storyteller SDK Docs with AI Assistants#

This guide explains how to use Storyteller SDK documentation with AI-powered coding assistants to enhance your development experience.

Why Use AI Assistants with Documentation#

AI coding assistants can significantly improve your development workflow when integrating the Storyteller SDK. By providing your tool with our documentation, you can:

  • Get contextually relevant code suggestions
  • Receive guidance based on Storyteller best practices
  • Accelerate your implementation process
  • Troubleshoot issues more effectively

Use the Showcase Integration Skill#

If you have access to the private Storyteller iOS Showcase repository, it includes an $integrate-storyteller skill at .agents/skills/integrate-storyteller/SKILL.md for AI coding assistants that support repository-local skills. It can guide a new integration, audit an existing integration, or help troubleshoot a problem using your app and the published Storyteller documentation.

Open the Showcase repository in your assistant's workspace alongside your iOS app, then ask:

Use $integrate-storyteller to help me integrate Storyteller into <path-to-my-ios-app>.

For an existing integration, ask the skill to audit the app instead. It will inspect your app as the primary source, ground its guidance in the published documentation, and identify assumptions explicitly.

If you do not have access to the Showcase repository or your assistant does not support repository-local skills, use the documentation bundle below.

Adding Documentation to Your Project#

Download llms.txt#

Download the Storyteller iOS documentation bundle and place it somewhere your editor can reference.

The bundle can be saved into your local repository and then referenced by your AI tool:

  1. Create a .ai/ directory in your project
  2. Save the downloaded content as .ai/storyteller-sdk-docs.md
  3. Point your tool to .ai/storyteller-sdk-docs.md and reference it in your prompts, or paste the relevant sections into the editor

For narrower context, read the aggregate bundle's <PAGE: slug> markers and request the corresponding concrete topic filename from the /ios/ai/ directory. For example, <PAGE: quickstart> maps to the Quickstart topic bundle.

Agents can also use the documentation search index to discover concrete documentation pages. Confirm important answers against those pages.

Example Prompts#

Here are some effective prompts to use with AI assistants when implementing Storyteller SDK:

  1. "Using the Storyteller SDK documentation, help me initialize the SDK in my Swift iOS app."

  2. "Based on the Storyteller documentation, what's the best way to implement a StorytellerStoriesRow SwiftUI view in my app?"

  3. "Help me troubleshoot this initialization error with Storyteller SDK: [paste your error]"

  4. "Using the Storyteller docs context, show me how to customize the theme of my StorytellerStoriesRow"

  5. "With the Storyteller documentation, help me implement analytics tracking for story views."

Additional Resources#