Compositions documentation - #278

Merged

czerwiukk merged 58 commits into

mainfrom

fce-2924-2925-smelter-cloud-docs

Aug 26, 2026

Commits on Aug 26, 2026

Add Smelter Cloud documentation section

Gawor270
authored and
czerwiukk
committed
42f5ac8
Publish the generated Smelter Cloud OpenAPI spec and align docs

Gawor270
authored and
czerwiukk
committed
ff4f6ac
Make the smelter-cloud spec source a submodule like the other APIs

Gawor270
authored and
czerwiukk
committed
1129c86
Address review comments

Gawor270
authored and
czerwiukk
committed
2155c73
Remove em dashes from the Smelter Cloud docs

Gawor270
authored and
czerwiukk
committed
55d64ca
Move the Smelter Cloud API reference under the API Reference tab

Gawor270
authored and
czerwiukk
committed
98a8544
Add Smelter Cloud REST API to the API Reference navbar dropdown

Gawor270
authored and
czerwiukk
committed
8954669
Unify the API Reference entry point

Gawor270
authored and
czerwiukk
committed
b3456e0
Give the API Reference tab its own sidebar

Gawor270
authored and
czerwiukk
committed
511d4ae
Integrate compositions into the core docs structure

Gawor270
authored and
czerwiukk
committed
df4bb7f
Rename the composition submodule key to match its path

Gawor270
authored and
czerwiukk
committed
95dfba8
Update the composition spec to the merged template-workers tip

Gawor270
authored and
czerwiukk
committed
7246ddd
Drop the composition spec presentation overlay

Gawor270
authored and
czerwiukk
committed
4446fb3
Correct composition lifecycle and forwarding details

Gawor270
authored and
czerwiukk
committed
a5b8106
Fix composition docs against the live API and track foundry main

Gawor270
authored and
czerwiukk
committed
02d99cd
Show the composed stream's destination in the tutorial diagram

Gawor270
authored and
czerwiukk
committed
b3d41de
Move scene updates into the tutorial and how-to

Gawor270
authored and
czerwiukk
committed
b8a9d32
Point the Smelter links at the right reference

Gawor270
authored and
czerwiukk
committed
7ec83fc
make main tutorial easier

Gawor270
authored and
czerwiukk
committed
2123a54
improve livestream input introduction

Gawor270
authored and
czerwiukk
committed
8e59b39
template tutorial make better

Gawor270
authored and
czerwiukk
committed
d6a31f3
make fishjam room compose tutorial better

Gawor270
authored and
czerwiukk
committed
1857f74
add warnings about cleaning up

Gawor270
authored and
czerwiukk
committed
8d03cd4
Add a markdownlint config

Gawor270
authored and
czerwiukk
committed
f08ccbd
Drop globs from the markdownlint config

Gawor270
authored and
czerwiukk
committed
55814f5
reduce reference to minimum

Gawor270
authored and
czerwiukk
committed
d67067a
update smelter version to 0.3.0

Gawor270
authored and
czerwiukk
committed
5c2d66c
improve text

Gawor270
authored and
czerwiukk
committed
a3a6fcd
Document the output resolution limits

Gawor270
authored and
czerwiukk
committed
47f8895
Refresh the composition spec from the pending API changes

Gawor270
authored and
czerwiukk
committed
1b3fe88
Fold the template pitch into the tutorial's next steps

Gawor270
authored and
czerwiukk
committed
2fe7deb
Name the two API surfaces the way the reference does

Gawor270
authored and
czerwiukk
committed
8088000
Stop describing compositions in terms of the hardware under them

Gawor270
authored and
czerwiukk
committed
1ee628f
Say plainly that a composition cannot be watched directly

Gawor270
authored and
czerwiukk
committed
4460d20
Name the destinations instead of calling them somewhere else

Gawor270
authored and
czerwiukk
committed
14116a9
remove crappy text

Gawor270
authored and
czerwiukk
committed
a92de2e
Fix the gaps found reviewing the composition docs

Gawor270
authored and
czerwiukk
committed
c17e3bb
simple text corrects

Gawor270
authored and
czerwiukk
committed
3795584
Call the corner layout the same thing in all three places

Gawor270
authored and
czerwiukk
committed
ec227d6
Show the composed frame instead of drawing it in ASCII

Gawor270
authored and
czerwiukk
committed
43e2580
Resolve the video path against the site base URL

Gawor270
authored and
czerwiukk
committed
76542bd
Show only the starting layout in the tutorial clip

Gawor270
authored and
czerwiukk
committed
d678217
Create the tutorial livestream through the Sandbox API

Gawor270
authored and
czerwiukk
committed
98fc7ae
Revert "Create the tutorial livestream through the Sandbox API"

Gawor270
authored and
czerwiukk
committed
0482655
Trim the sentence describing what you should see

Gawor270
authored and
czerwiukk
committed
a8278c9
Create the tutorial livestream through the Sandbox API, unlisted

Gawor270
authored and
czerwiukk
committed
d056211
Drop vdo.ninja and a playback claim the tutorial no longer supports

Gawor270
authored and
czerwiukk
committed
aeea135
Call the token the same thing in the prose and the placeholder

Gawor270
authored and
czerwiukk
committed
55435da
Point the events how-to at deploying and at getting a livestream

Gawor270
authored and
czerwiukk
committed
05ed01e
Define every variable the composition how-tos use

Gawor270
authored and
czerwiukk
committed
33324e8
Set up the composition and livestream right before deploying

Gawor270
authored and
czerwiukk
committed
b00849f
Just say what to create, without the reasoning

Gawor270
authored and
czerwiukk
committed
ea5c515
Take the Sandbox API URL from the panel, not from the Fishjam ID

Gawor270
authored and
czerwiukk
committed
475b800
Create the events composition after the template, not before

Gawor270
authored and
czerwiukk
committed
0abfd4f
Spell out the WHIP publish address correctly

Gawor270
authored and
czerwiukk
committed
0f38708
Say what actually keeps a composition alive

Gawor270
authored and
czerwiukk
committed
1d4b8fa
Refresh the composition spec from main and drop HLS input

Gawor270
authored and
czerwiukk
committed
8b15b30
Refresh the composition spec and drop app from the RTMP input

Gawor270
authored and
czerwiukk
committed
ddf5459