Compositions documentation - #278

Open

Gawor270 wants to merge 59 commits into

mainfrom

fce-2924-2925-smelter-cloud-docs

Commits on Jul 23, 2026

Add Smelter Cloud documentation section
Gawor270
committed
23693ac

Commits on Jul 24, 2026

Publish the generated Smelter Cloud OpenAPI spec and align docs
Gawor270
committed
d240d02
Make the smelter-cloud spec source a submodule like the other APIs
Gawor270
committed
abd8188
Address review comments
Gawor270
committed
6fd1611
Remove em dashes from the Smelter Cloud docs
Gawor270
committed
6f781f3
Move the Smelter Cloud API reference under the API Reference tab
Gawor270
committed
123ed00
Add Smelter Cloud REST API to the API Reference navbar dropdown
Gawor270
committed
31d5153

Commits on Jul 27, 2026

Commits on Jul 30, 2026

Commits on Aug 6, 2026

Fix composition docs against the live API and track foundry main
Gawor270
committed
ed734ae
Merge branch 'main' into fce-2924-2925-smelter-cloud-docs
Gawor270
authored
86e0307
Show the composed stream's destination in the tutorial diagram
Gawor270
committed
ad2af21
Move scene updates into the tutorial and how-to
Gawor270
committed
adc70b4
Point the Smelter links at the right reference
Gawor270
committed
f2035e3
make main tutorial easier
Gawor270
committed
4a1b8da
improve livestream input introduction
Gawor270
committed
b8e9492
template tutorial make better
Gawor270
committed
57915c8
make fishjam room compose tutorial better
Gawor270
committed
30becb5
add warnings about cleaning up
Gawor270
committed
eb3e56d

Commits on Aug 7, 2026

Add a markdownlint config
Gawor270
committed
652abc9
Drop globs from the markdownlint config
Gawor270
committed
aa42871
reduce reference to minimum
Gawor270
committed
87a996f
update smelter version to 0.3.0
Gawor270
committed
99d830f
improve text
Gawor270
committed
c7e0c37
Document the output resolution limits
Gawor270
committed
f811b49

Commits on Aug 11, 2026

Refresh the composition spec from the pending API changes
Gawor270
committed
89dee2e
Fold the template pitch into the tutorial's next steps
Gawor270
committed
30e2567
Name the two API surfaces the way the reference does
Gawor270
committed
777ae62
Stop describing compositions in terms of the hardware under them
Gawor270
committed
4c12a54
Say plainly that a composition cannot be watched directly
Gawor270
committed
de3cb17
Name the destinations instead of calling them somewhere else
Gawor270
committed
a1fd3df
remove crappy text
Gawor270
committed
4d888f3
Fix the gaps found reviewing the composition docs
Gawor270
committed
ff20df1

Commits on Aug 13, 2026

simple text corrects
Gawor270
committed
58dce02
Call the corner layout the same thing in all three places
Gawor270
committed
0c7d341
Show the composed frame instead of drawing it in ASCII
Gawor270
committed
daa9c82
Resolve the video path against the site base URL
Gawor270
committed
2666efe
Show only the starting layout in the tutorial clip
Gawor270
committed
84f6d54
Create the tutorial livestream through the Sandbox API
Gawor270
committed
2f8fdc0
Revert "Create the tutorial livestream through the Sandbox API"
Gawor270
committed
d69e4b9
Trim the sentence describing what you should see
Gawor270
committed
6cde3f7
Create the tutorial livestream through the Sandbox API, unlisted
Gawor270
committed
0c711d2
Drop vdo.ninja and a playback claim the tutorial no longer supports
Gawor270
committed
5683558
Call the token the same thing in the prose and the placeholder
Gawor270
committed
0dcb06d
Point the events how-to at deploying and at getting a livestream
Gawor270
committed
7aba97c
Define every variable the composition how-tos use
Gawor270
committed
331ddda
Set up the composition and livestream right before deploying
Gawor270
committed
d0dbb5e
Just say what to create, without the reasoning
Gawor270
committed
3277582

Commits on Aug 14, 2026

Take the Sandbox API URL from the panel, not from the Fishjam ID
Gawor270
committed
32d68a3
Create the events composition after the template, not before
Gawor270
committed
6430b52
Spell out the WHIP publish address correctly
Gawor270
committed
77cec77
Say what actually keeps a composition alive
Gawor270
committed
0175555
Refresh the composition spec from main and drop HLS input
Gawor270
committed
a91550e