Skip to content

Commit

Permalink
More docs for v1.2 (#923)
Browse files Browse the repository at this point in the history 
* Add timer usage examples WiP

* lifecycle guide wip

* Fix typos

* Add new guide to mix.exs

* Improve timer guide

* Add mermaid graphs visualising specs WiP

* Set version of ex_doc, upgrade timer example

* Add svg images visualizing pipeline topology

* Copy spec action doc from bin to pipeline

* Implement suggestion from CR

* Apply grammarly

* Some upgrades

* grammarly

* Remove unnecessary raise

* Upgrade timer demo

* Fix typos

* Apply CR

* Add drawio schemes

* Add one more example about specs

* Fix typo

* Add small comment
  • Loading branch information
@FelonEkonom
FelonEkonom authored Jan 20, 2025
1 parent 29ba0b4 commit 8b761f5
Show file tree
Hide file tree
Showing 11 changed files with 526 additions and 8 deletions.
133 changes: 133 additions & 0 deletions assets/drawio_schemes/spec_with_audio.drawio
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:133.0) Gecko/20100101 Firefox/133.0" version="26.0.2">
<diagram name="Page-1" id="kuVSDCUKA40HAu_zZMdI">
<mxGraphModel dx="813" dy="1000" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="xHBaNdvFiFH15lWm7bkn-2" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="80" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-39" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=1;exitY=0.5;exitDx=0;exitDy=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" source="xHBaNdvFiFH15lWm7bkn-3" target="xHBaNdvFiFH15lWm7bkn-35">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-3" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="200" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-4" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="320" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-5" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="440" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-6" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="560" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-7" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="680" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-8" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" target="xHBaNdvFiFH15lWm7bkn-3">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="420" y="140" as="sourcePoint" />
<mxPoint x="470" y="90" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-11" value=":file_source" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="95" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-12" value=":demuxer" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="215" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-13" value=":decoder" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="335" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-14" value=":ai_filter" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="455" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-15" value=":encoder" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="575" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-16" value=":webrtc_sink" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="695" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-17" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="140" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-18" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="170" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-19" value=":video" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="260" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-22" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="290" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-25" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" target="xHBaNdvFiFH15lWm7bkn-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="420" y="260" as="sourcePoint" />
<mxPoint x="470" y="210" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-26" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="419" y="380" as="sourcePoint" />
<mxPoint x="419" y="440" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-27" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="419" y="500" as="sourcePoint" />
<mxPoint x="419" y="560" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-28" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="419" y="620" as="sourcePoint" />
<mxPoint x="419" y="680" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-29" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="380" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-30" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="500" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-31" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="620" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-32" value=":video" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="650" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-33" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="410" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-34" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="530" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-35" value="&lt;font style=&quot;font-size: 18px;&quot;&gt;:scratch_remover&lt;/font&gt;" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="530" y="440" width="160" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-38" value="" style="endArrow=classic;html=1;rounded=0;entryX=1;entryY=0.5;entryDx=0;entryDy=0;exitX=0.5;exitY=1;exitDx=0;exitDy=0;" edge="1" parent="1" source="xHBaNdvFiFH15lWm7bkn-35" target="xHBaNdvFiFH15lWm7bkn-7">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="660" y="502.5" as="sourcePoint" />
<mxPoint x="710" y="452.5" as="targetPoint" />
<Array as="points">
<mxPoint x="610" y="710" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-41" value=":audio" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="480" y="200" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-42" value=":audio" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="480" y="680" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-43" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="610" y="500" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-44" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="610" y="410" width="60" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
106 changes: 106 additions & 0 deletions assets/drawio_schemes/spec_without_audio.drawio
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<mxfile host="app.diagrams.net" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:133.0) Gecko/20100101 Firefox/133.0" version="26.0.2">
<diagram name="Page-1" id="kuVSDCUKA40HAu_zZMdI">
<mxGraphModel dx="813" dy="1000" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="850" pageHeight="1100" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="xHBaNdvFiFH15lWm7bkn-2" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="80" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-3" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="200" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-4" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="320" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-5" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="440" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-6" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="560" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-7" value="" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxGeometry x="360" y="680" width="120" height="60" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-8" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" target="xHBaNdvFiFH15lWm7bkn-3">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="420" y="140" as="sourcePoint" />
<mxPoint x="470" y="90" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-11" value=":file_source" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="95" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-12" value=":demuxer" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="215" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-13" value=":decoder" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="335" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-14" value=":ai_filter" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="455" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-15" value=":encoder" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="575" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-16" value=":webrtc_sink" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=18;" vertex="1" parent="1">
<mxGeometry x="390" y="695" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-17" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="140" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-18" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="170" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-19" value=":video" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="260" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-22" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="290" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-25" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1" target="xHBaNdvFiFH15lWm7bkn-4">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="420" y="260" as="sourcePoint" />
<mxPoint x="470" y="210" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-26" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="419" y="380" as="sourcePoint" />
<mxPoint x="419" y="440" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-27" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="419" y="500" as="sourcePoint" />
<mxPoint x="419" y="560" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-28" value="" style="endArrow=classic;html=1;rounded=0;entryX=0.5;entryY=0;entryDx=0;entryDy=0;" edge="1" parent="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="419" y="620" as="sourcePoint" />
<mxPoint x="419" y="680" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-29" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="380" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-30" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="500" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-31" value=":output" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="620" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-32" value=":video" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="650" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-33" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="410" width="60" height="30" as="geometry" />
</mxCell>
<mxCell id="xHBaNdvFiFH15lWm7bkn-34" value=":input" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;" vertex="1" parent="1">
<mxGeometry x="420" y="530" width="60" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
4 changes: 4 additions & 0 deletions assets/images/spec_with_audio.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions assets/images/spec_without_audio.svg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 8b761f5

Please sign in to comment.