Skip to content

docs: Add comprehensive timing and preparation guide#1660

Draft
rjmunro wants to merge 1 commit intoSofie-Automation:mainfrom
rjmunro:rjmunro/timing-docs
Draft

docs: Add comprehensive timing and preparation guide#1660
rjmunro wants to merge 1 commit intoSofie-Automation:mainfrom
rjmunro:rjmunro/timing-docs

Conversation

@rjmunro
Copy link
Contributor

@rjmunro rjmunro commented Feb 19, 2026

About the Contributor

This pull request is posted on behalf of myself

Type of Contribution

This is a Documentation improvement

Current Behavior

N/a

New Behavior

  • Add timing-and-preparation.md covering lookahead, preroll, preliminary, and transitions
  • Add glossary.md with definitions of all key Sofie concepts
  • Document how timing mechanisms work together with adlibs
  • Explain device latency compensation strategies
  • Add cross-references between related documentation pages

This addresses common questions about when to use each timing mechanism and how they interact, especially for adlib scenarios where lookahead cannot predict operator actions.

Testing

  • I have added one or more unit tests for this PR
  • I have updated the relevant unit tests
  • No unit test changes are needed for this PR

Affected areas

Time Frame

Other Information

Status

  • PR is ready to be reviewed.
  • The functionality has been tested by the author.
  • Relevant unit tests has been added / updated.
  • Relevant documentation (code comments, system documentation) has been added / updated.

- Add timing-and-preparation.md covering lookahead, preroll, preliminary, and transitions
- Add glossary.md with definitions of all key Sofie concepts
- Document how timing mechanisms work together with adlibs
- Explain device latency compensation strategies
- Add cross-references between related documentation pages

This addresses common questions about when to use each timing mechanism
and how they interact, especially for adlib scenarios where lookahead
cannot predict operator actions.
@coderabbitai
Copy link

coderabbitai bot commented Feb 19, 2026

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@codecov
Copy link

codecov bot commented Feb 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant