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 like GitHub Copilot, Claude, Codex, and Cursor can significantly improve your development workflow when integrating the Storyteller SDK. By providing these AI tools 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 Editor#

AI-enabled editors can index and use Storyteller SDK documentation to provide more accurate suggestions. Here's how you can add our docs to various AI assistants:

Download llms.txt#

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

Editor-Specific Instructions#

Cursor#

Cursor includes the ability to add project-specific documentation:

  1. Open your Storyteller SDK project in Cursor
  2. Use the /file command and reference public-docs/ai/llms.txt to add it to your chat context:
/file public-docs/ai/llms.txt
  1. Ask questions about Storyteller SDK implementation

GitHub Copilot#

Add the documentation to your project context. This approach also works for other tools like Cursor, Claude, Codex, and ChatGPT (desktop or IDE-integrated versions).

  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

Zed#

In Zed, you can:

  1. Use the /file command to add the documentation to your chat:
/file public-docs/ai/llms.txt
  1. Reference the documentation in your queries

Claude, Codex, ChatGPT, and Other Web-Based AIs#

For web-based AI tools, you can:

  1. Copy the content from public-docs/ai/llms.txt
  2. Paste it at the beginning of your conversation or chat session
  3. Preface your prompts with instructions to consider this documentation

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 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#