For Developers
Technical documentation for developers, contributors, and those maintaining Telar forks.
Who This Section Is For
This section is designed for:
- Developers building features or fixing bugs in Telar
- Maintainers of Telar forks for specific institutions
- Contributors wanting to understand Telar’s architecture
- Advanced users troubleshooting build issues or customizing the framework
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 Development
Set up your development environment, run builds locally, and test changes before deploying.
8.2 GitHub Actions Reference
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 Architecture
Technical details of Telar’s iframe embedding system and how it handles different contexts.
Contributing to Telar
Telar is open source and welcomes contributions. Before contributing:
- Set up local development (8.1) to test your changes
- Understand the build system (8.2, 8.3) to see how content is processed
- Follow the existing patterns in the codebase
- Test thoroughly before submitting pull requests
Repository: UCSB-AMPLab/telar
Getting Help
- Issues: Report bugs or request features on GitHub Issues
- Discussions: Ask questions in GitHub Discussions
- Email: Contact the maintainers for sensitive issues or institutional partnerships
Quick Links
- Main Documentation - User-facing docs for storytellers
- Configuration Reference - All _config.yml options
- CSV Reference - Complete CSV column documentation