Skip to content

Use the docs with AI assistants#

The Storyteller Web SDK docs are also published as plain-text files for AI coding assistants, such as GitHub Copilot, Claude, Codex, ChatGPT, and Cursor. Give your assistant these files so that its answers use the Web SDK API as documented.

Why use the docs with an AI assistant#

An assistant that has the Storyteller docs in context can:

  • Suggest code that matches the Web SDK API
  • Help you troubleshoot initialization, themes, analytics, and ads
  • Use the documented options and defaults instead of guessing them

Check important answers against the docs pages.

Copy one page#

Every page except the documentation home has a Copy for AI button next to its title. The button copies the page's AI file: a summary of the page, followed by the full page in Markdown. Paste it into your assistant's chat. On this page, the button copies the whole bundle described in the next section.

The button's menu also has Copy as Markdown, which copies only the page's Markdown.

Add the whole bundle to your project#

Download the documentation bundle from https://docs.getstoryteller.com/web/ai/llms.txt. It contains a summary of every page in navigation order. Each summary starts with a <PAGE: slug> marker.

To use the bundle in your project:

  1. Create a .ai/ directory in your project.
  2. Save the bundle as .ai/storyteller-web-sdk-docs.md.
  3. Point your assistant to that file and mention it in your prompts.

In an editor assistant, such as Cursor, Zed, or GitHub Copilot, attach or reference the saved file in the chat. In a web-based assistant, upload the file, or paste its contents at the start of a new chat. Long pastes may be truncated.

Use per-page files#

When you need one topic, give your assistant that page's file. It contains the page summary and the full page. Each page's file is at:

https://docs.getstoryteller.com/web/ai/llms-<slug>.txt

The <slug> is the same slug as in the bundle's <PAGE: slug> marker. To work it out from a page's URL, take the path after https://docs.getstoryteller.com/web/ and remove the trailing slash. Replace each / with -, add a hyphen before each capital letter inside a word, and use lowercase letters. For a section overview page whose URL ends in a folder name, add -index.

Page URL path Slug File
Themes/ themes llms-themes.txt
StorytellerRowView/ storyteller-row-view llms-storyteller-row-view.txt
getting-started/npm/ getting-started-npm llms-getting-started-npm.txt
getting-started/ getting-started-index llms-getting-started-index.txt

Release notes#

The bundle doesn't include the release notes. Download them separately from https://docs.getstoryteller.com/web/ai/llms-changelog.txt, or copy them from the Release notes page.

Search the docs#

An assistant that can fetch URLs can use the docs search index to find the right page: https://docs.getstoryteller.com/web/search/search_index.json. It lists the title, location, and text of each page and section. Check important answers against the pages it finds.

Example prompts#

  • "Using the Storyteller Web SDK docs, initialize Storyteller and show a Story row on my page."
  • "Show a minimal StorytellerStoriesRowView integration and how to reload its data."
  • "Which callbacks do I implement to send Storyteller analytics events to my analytics tool?"
  • "Help me build a UiTheme with our brand colors for light and dark mode."
  • "Implement getAdConfig for Google Ad Manager with Story and Clip Category targeting."
  • "Help me fix this Storyteller initialization error: [paste the error]."