Docs Documentación

For Developers

Technical documentation for developers, contributors, and those maintaining Telar forks.

Who This Section Is For

This section is designed for:

If you’re a storyteller creating content for a Telar site, you probably want the main documentation sections instead.

What’s In This Section

8.1 Local Dev Setup

Set up your development environment, run builds locally, and test changes before deploying.

8.2 GitHub Actions

Understand Telar’s automated build workflow and how to customize the deployment pipeline.

8.3 Demo System Architecture

Learn how the demo content fetching system works, from version matching to bundle integration.

8.4 Embedding System

Technical details of Telar’s iframe embedding system and how it handles different contexts.

8.5 Advanced Styling

Customize Telar’s styles with custom CSS, CSS variables and cascade layers.

8.6 Layouts and Small Screens

How the story page chooses between its two layouts, and how the site adapts to small and short windows.

8.7 Story Engine Vocabulary

The terms the story engine’s code and these docs use for a story’s parts, its moves and its layouts.

Contributing to Telar

Telar is open source and welcomes contributions. Before contributing:

  1. Set up local development (8.1) to test your changes
  2. Understand the build system (8.2, 8.3) to see how content is processed
  3. Follow the existing patterns in the codebase
  4. Test thoroughly before submitting pull requests

Repository: UCSB-AMPLab/telar

Getting Help