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

Adding Documentation to Your Project#

Download llms.txt#

Copy public-docs/ai/llms.txt from the repository and place it somewhere your editor can reference.

The public-docs/ai/llms.txt file can be saved into your local repository and then referenced by your AI tool following these instructions:

  1. Create a .ai/ directory in your project
  2. Copy the content from public-docs/ai/llms.txt to a new file named storyteller-sdk-docs.md in that directory
  3. Point your tool to .ai/storyteller-sdk-docs.md and reference it in your prompts; or its contents can just be pasted into the editor.

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#