Instruqt · Authoring Library

Instruqt Track Builder Library
The Reference Set

Five document types covering every architectural and authoring decision you'll make on a track — design, build, ship, maintain.

22
Resources
4
Guides
18
References
5
Document Types
Guides

Long-Form Documents

4 documents
Field Guide
The Instruqt Track Builder's Field Guide
Walks the lifecycle of an Instruqt track end to end — discovery, design, scaffold, build, polish, ship, maintain. Eighteen chapters plus appendices.
Open field guide →
Booklet
Building Better Instruqt Tracks
Twenty-five opinionated principles for building tracks that ship cleanly. One principle per chapter, drawn from production track scars.
Open booklet →
Cookbook
Instruqt Track Patterns Cookbook
Fifty-five copy-friendly recipes across Infrastructure, Technique, and Author categories. Each recipe self-contained — Problem, Solution, Skeleton, Gotchas, Variations.
Open cookbook →
Decision Guide
Instruqt Decision Trees
Sixteen architectural decisions as navigable Q&A trees. Each terminal recommendation links to the implementing Cookbook recipe.
Open decision guide →
Reference

Quick Reference Pages

18 pages
01
track.yml fields
Track-level metadata and UI configuration. Sits at the root of every track…
 02
config.yml resource types
Infrastructure declaration. version: "3" at the top, then resources. Skip…
 03
Auto-injected environment variables
Available in every lifecycle script (setup / check / solve / cleanup) without…
 04
Base images
Pick by what's pre-installed and how fast it boots. Reach for descriptive…
 05
Assignment tab types
Six tab types group naturally by what they connect to: internal (your declared…
 06
Code block modifiers
Modifiers placed after the opening fence and language identifier turn static…
 07
Markdown extensions
Instruqt extends standard Markdown in assignment.md with interactive elements,…
 08
Lifecycle scripts
Bash scripts on Linux, PowerShell on Windows. The filename encodes the target…
 09
Granular check pattern
Independent assertions, each with its own remediation message. Turns a failed…
 10
agent variable + Instruqt-Var
The agent's variable store is a key-value bridge between scripts and assignment…
 11
machine_type sizing matrix
VM sizing strings for virtualmachines: . Prefer machine_type: over memory: +…
 12
Common ports
Conventional ports for in-track services. Match these to ports: in config.yml ,…
 13
Variable interpolation
Two interpolation syntaxes. [[ Instruqt-Var ]] reads from the agent variable…
 14
Common library reference
Helper commands shipped on Instruqt-published images. Available in every…
 15
Time conventions
Track-level time settings and the conventional timelimit / idle_timeout…
 16
Wait, readiness, retry helpers
Setup scripts boot before the learner sees anything — the difference between…
 17
Anti-pattern quick-reference
Don't on the left, fix on the right. Read before push, scan when something…
 18
Visual identity
Standards for any HTML artifact in the publishing system. Cheat sheets and…