Skip to content

Commit

Permalink
Merge pull request #2390 from mbeddr/bugfix/documentation_improvements
Browse files Browse the repository at this point in the history
Documentation improvements
  • Loading branch information
alexanderpann authored Mar 28, 2024
2 parents 27ff94f + dffce3d commit 490985c
Show file tree
Hide file tree
Showing 115 changed files with 5,266 additions and 2,201 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Semantic Versioning and the changes are simply documented in reverse chronologic

### Fixed

- Many usability were fixed and the editors (including presentation mode) polished.
- Higher level of nesting in sections is now support by all generators.
- PlantUML was updated to PlantUML to v1.2023.13 EPL version (regression bug).

# January 2024
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<registry>
<language id="2dec0852-3a21-4c4e-a68c-b05236cc37f2" name="com.mbeddr.doc.gen_xhtml">
<concept id="3350625596580275037" name="com.mbeddr.doc.gen_xhtml.structure.HTMLRenderer" flags="ng" index="1_07dB" />
<concept id="3498379661306969557" name="com.mbeddr.doc.gen_xhtml.structure.HTMLDummyRenderer" flags="ng" index="1TaS0h" />
<concept id="3498379661306969557" name="com.mbeddr.doc.gen_xhtml.structure.HTMLNoOutputRenderer" flags="ng" index="1TaS0h" />
</language>
<language id="86ef8290-12bb-4ca7-947f-093788f263a9" name="jetbrains.mps.lang.project">
<concept id="1855399583446016268" name="jetbrains.mps.lang.project.structure.ModuleReference" flags="ng" index="A2Dkr">
Expand Down Expand Up @@ -156,7 +156,7 @@
<language id="e06345c7-da82-4f8b-bd44-1425fe158640" name="com.mbeddr.doc.meta">
<concept id="4411878964391860302" name="com.mbeddr.doc.meta.structure.SolutionRefWord" flags="ng" index="XCBN5" />
<concept id="4411878964391805161" name="com.mbeddr.doc.meta.structure.AbstractModuleRefWord" flags="ng" index="XFqhy">
<child id="4411878964391805166" name="moduleRef" index="XFqh_" />
<child id="4411878964391805166" name="moduleRefOld" index="XFqh_" />
</concept>
<concept id="8408742697223012410" name="com.mbeddr.doc.meta.structure.LanguageRefWord" flags="ng" index="3R4DFk" />
</language>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -810,7 +810,7 @@
</node>
<node concept="2qmXGp" id="734bZEPApph" role="3TlMhI">
<node concept="3ZVu4v" id="zSFqGmbhf6" role="1_9fRO">
<ref role="3ZVs_2" node="5k1FOfehbV6" resolve="tp1" />
<ref role="3ZVs_2" node="5k1FOfehbV6" />
</node>
<node concept="1E4Tgc" id="734bZEPAppi" role="1ESnxz">
<ref role="1E4Tge" node="1w5Xuj1QYMD" resolve="alt" />
Expand All @@ -832,7 +832,7 @@
</node>
<node concept="2qmXGp" id="734bZEPApMb" role="3TlMhI">
<node concept="3ZVu4v" id="zSFqGmbhf8" role="1_9fRO">
<ref role="3ZVs_2" node="5k1FOfehbV6" resolve="tp1" />
<ref role="3ZVs_2" node="5k1FOfehbV6" />
</node>
<node concept="1E4Tgc" id="734bZEPApMc" role="1ESnxz">
<ref role="1E4Tge" node="1w5Xuj1QYMD" resolve="alt" />
Expand All @@ -845,7 +845,7 @@
<node concept="3pqW6w" id="5k1FOfehd8B" role="1_9egR">
<node concept="3wxyx2" id="5k1FOfehcz5" role="3TlMhI">
<node concept="3ZVu4v" id="zSFqGmbhf9" role="1_9fRO">
<ref role="3ZVs_2" node="5k1FOfehcdc" resolve="y" />
<ref role="3ZVs_2" node="5k1FOfehcdc" />
</node>
</node>
<node concept="3TlMh9" id="5k1FOfehd8M" role="3TlMhJ">
Expand All @@ -860,7 +860,7 @@
</node>
<node concept="3wxyx2" id="5k1FOfehd9E" role="3TlMhI">
<node concept="3ZVu4v" id="zSFqGmbhfa" role="1_9fRO">
<ref role="3ZVs_2" node="5k1FOfehcdc" resolve="y" />
<ref role="3ZVs_2" node="5k1FOfehcdc" />
</node>
</node>
</node>
Expand All @@ -870,7 +870,7 @@
<node concept="3TlM44" id="5k1FOfehdaH" role="c0Tn6">
<node concept="2qmXGp" id="734bZEPAped" role="3TlMhI">
<node concept="3ZVu4v" id="zSFqGmbhfk" role="1_9fRO">
<ref role="3ZVs_2" node="5k1FOfehd7G" resolve="tp2" />
<ref role="3ZVs_2" node="5k1FOfehd7G" />
</node>
<node concept="1E4Tgc" id="734bZEPApee" role="1ESnxz">
<ref role="1E4Tge" node="1w5Xuj1QYMD" resolve="alt" />
Expand All @@ -892,7 +892,7 @@
<node concept="3TlM44" id="5k1FOfehde5" role="c0Tn6">
<node concept="2qmXGp" id="734bZEPApGn" role="3TlMhI">
<node concept="3ZVu4v" id="zSFqGmbhfl" role="1_9fRO">
<ref role="3ZVs_2" node="5k1FOfehd7G" resolve="tp2" />
<ref role="3ZVs_2" node="5k1FOfehd7G" />
</node>
<node concept="1E4Tgc" id="734bZEPApGo" role="1ESnxz">
<ref role="1E4Tge" node="1w5Xuj1QYMD" resolve="alt" />
Expand Down Expand Up @@ -1255,14 +1255,14 @@
<node concept="3pqW6w" id="6URxCt9p_oD" role="1_9egR">
<node concept="2BOciq" id="6URxCt9p_oJ" role="3TlMhJ">
<node concept="3mKm_2" id="6URxCt9p_oM" role="3TlMhJ">
<ref role="3mKm_0" node="6URxCt9p_op" resolve="b" />
<ref role="3mKm_0" node="6URxCt9p_op" />
</node>
<node concept="3mKm_2" id="6URxCt9p_oG" role="3TlMhI">
<ref role="3mKm_0" node="6URxCt9p_ol" resolve="a" />
<ref role="3mKm_0" node="6URxCt9p_ol" />
</node>
</node>
<node concept="3mKm_2" id="6URxCt9p_oA" role="3TlMhI">
<ref role="3mKm_0" node="6URxCt9p_oy" resolve="sum" />
<ref role="3mKm_0" node="6URxCt9p_oy" />
</node>
</node>
</node>
Expand All @@ -1279,7 +1279,7 @@
<property role="2hmy$m" value="0" />
</node>
<node concept="3mKm_2" id="6URxCt9p_oS" role="3TlMhI">
<ref role="3mKm_0" node="6URxCt9p_oy" resolve="sum" />
<ref role="3mKm_0" node="6URxCt9p_oy" />
</node>
</node>
</node>
Expand Down Expand Up @@ -1351,22 +1351,22 @@
<node concept="1_9egQ" id="6URxCt9p_pM" role="3XIRFZ">
<node concept="3pqW6w" id="6URxCt9p_pU" role="1_9egR">
<node concept="3mKm_2" id="6URxCt9p_pX" role="3TlMhJ">
<ref role="3mKm_0" node="6URxCt9p_p2" resolve="signal" />
<ref role="3mKm_0" node="6URxCt9p_p2" />
</node>
<node concept="2wJmCr" id="6URxCt9p_pQ" role="3TlMhI">
<node concept="3mKmzY" id="6URxCt9p_pN" role="1_9fRO">
<ref role="3mKmyW" node="6URxCt9p_p9" resolve="values" />
<ref role="3mKmyW" node="6URxCt9p_p9" />
</node>
<node concept="3mKmzY" id="6URxCt9p_pR" role="2wJmCp">
<ref role="3mKmyW" node="6URxCt9p_pG" resolve="index" />
<ref role="3mKmyW" node="6URxCt9p_pG" />
</node>
</node>
</node>
</node>
<node concept="1_9egQ" id="6URxCt9p_pZ" role="3XIRFZ">
<node concept="3TM6Ey" id="6URxCt9p_q3" role="1_9egR">
<node concept="3mKmzY" id="6URxCt9p_q0" role="1_9fRO">
<ref role="3mKmyW" node="6URxCt9p_pG" resolve="index" />
<ref role="3mKmyW" node="6URxCt9p_pG" />
</node>
</node>
</node>
Expand All @@ -1378,32 +1378,32 @@
<property role="2hmy$m" value="0" />
</node>
<node concept="3mKmzY" id="6URxCt9p_qh" role="3TlMhI">
<ref role="3mKmyW" node="6URxCt9p_pG" resolve="index" />
<ref role="3mKmyW" node="6URxCt9p_pG" />
</node>
</node>
</node>
</node>
<node concept="3Tl9Jr" id="6URxCt9p_qc" role="c0U16">
<node concept="3mKmVa" id="6URxCt9p_qf" role="3TlMhJ">
<ref role="3mKmV8" node="6URxCt9p_pg" resolve="avgOver" />
<ref role="3mKmV8" node="6URxCt9p_pg" />
</node>
<node concept="3mKmzY" id="6URxCt9p_q9" role="3TlMhI">
<ref role="3mKmyW" node="6URxCt9p_pG" resolve="index" />
<ref role="3mKmyW" node="6URxCt9p_pG" />
</node>
</node>
</node>
<node concept="1_9egQ" id="6URxCt9p_qp" role="3XIRFZ">
<node concept="3pqW6w" id="6URxCt9p_qt" role="1_9egR">
<node concept="3mKm_2" id="6URxCt9p_qq" role="3TlMhI">
<ref role="3mKm_0" node="6URxCt9p_p6" resolve="integrated" />
<ref role="3mKm_0" node="6URxCt9p_p6" />
</node>
<node concept="3O_q_g" id="6URxCt9pArT" role="3TlMhJ">
<ref role="3O_q_h" node="6URxCt9p_qA" resolve="avg" />
<node concept="3mKmzY" id="6URxCt9pArU" role="3O_q_j">
<ref role="3mKmyW" node="6URxCt9p_p9" resolve="values" />
<ref role="3mKmyW" node="6URxCt9p_p9" />
</node>
<node concept="3mKmVa" id="6URxCt9pArW" role="3O_q_j">
<ref role="3mKmV8" node="6URxCt9p_pg" resolve="avgOver" />
<ref role="3mKmV8" node="6URxCt9p_pg" />
</node>
</node>
</node>
Expand All @@ -1418,10 +1418,10 @@
<node concept="1_9egQ" id="6URxCt9p_pr" role="3XIRFZ">
<node concept="3pqW6w" id="6URxCt9p_pv" role="1_9egR">
<node concept="3mKm_2" id="6URxCt9p_py" role="3TlMhJ">
<ref role="3mKm_0" node="6URxCt9p_p2" resolve="signal" />
<ref role="3mKm_0" node="6URxCt9p_p2" />
</node>
<node concept="3mKm_2" id="6URxCt9p_ps" role="3TlMhI">
<ref role="3mKm_0" node="6URxCt9p_p6" resolve="integrated" />
<ref role="3mKm_0" node="6URxCt9p_p6" />
</node>
</node>
</node>
Expand Down Expand Up @@ -1559,7 +1559,7 @@
<node concept="3Iwmk6" id="4Kv0gUyBAQ5" role="3Iwmkm">
<property role="TrG5h" value="eprom" />
<node concept="3IwmM6" id="4Kv0gUyBBN5" role="3Iwmk4">
<ref role="3IwvBm" node="4Kv0gUyBAQ0" resolve="ram" />
<ref role="3IwvBm" node="4Kv0gUyBAQ0" />
</node>
<node concept="3TlMh9" id="4Kv0gUyBBN6" role="3IwmBf">
<property role="2hmy$m" value="2048" />
Expand All @@ -1568,18 +1568,18 @@
<node concept="3Iwmk6" id="4Kv0gUyBG4w" role="3Iwmkm">
<property role="TrG5h" value="devices" />
<node concept="3Iwolw" id="4Kv0gUyBG4z" role="3Iwmk4">
<ref role="3IwvBm" node="4Kv0gUyBAQ5" resolve="eprom" />
<ref role="3IwvBm" node="4Kv0gUyBAQ5" />
</node>
<node concept="2BOciq" id="4Kv0gUyBG4G" role="3IwmBf">
<node concept="3IwmM6" id="4Kv0gUyBGaV" role="3TlMhI">
<ref role="3IwvBm" node="4Kv0gUyBG4w" resolve="devices" />
<ref role="3IwvBm" node="4Kv0gUyBG4w" />
</node>
<node concept="2BOcij" id="4Kv0gUyBG4B" role="3TlMhJ">
<node concept="3TlMh9" id="4Kv0gUyBG4E" role="3TlMhJ">
<property role="2hmy$m" value="2" />
</node>
<node concept="3IwrmH" id="4Kv0gUyBG4$" role="3TlMhI">
<ref role="3IwvBm" node="4Kv0gUyBAQ0" resolve="ram" />
<ref role="3IwvBm" node="4Kv0gUyBAQ0" />
</node>
</node>
</node>
Expand All @@ -1603,7 +1603,7 @@
<property role="TrG5h" value="empty_1352810980965_2" />
</node>
<node concept="3IwAZp" id="4Kv0gUyBn8f" role="N3F5h">
<ref role="3IwAZn" node="6URxCt9pDSX" resolve="Measurement" />
<ref role="3IwAZn" node="6URxCt9pDSX" />
<node concept="3XIRFW" id="4Kv0gUyBn8g" role="3IwAZC">
<node concept="3$f84D" id="7HJwNEvoC$_" role="3XIRFZ">
<node concept="3XIRFW" id="7HJwNEvoC$B" role="3$f85X">
Expand All @@ -1617,7 +1617,7 @@
<ref role="1E4Tge" node="7HJwNEvpaAb" resolve="rpm" />
</node>
<node concept="3$f86x" id="7HJwNEvoCMF" role="1_9fRO">
<ref role="3$f86A" node="7HJwNEvrahF" resolve="data" />
<ref role="3$f86A" node="7HJwNEvrahF" />
</node>
</node>
</node>
Expand All @@ -1632,14 +1632,14 @@
<ref role="1E4Tge" node="7HJwNEvpaA9" resolve="speed" />
</node>
<node concept="3$f86x" id="7HJwNEvr9Ky" role="1_9fRO">
<ref role="3$f86A" node="7HJwNEvrahF" resolve="data" />
<ref role="3$f86A" node="7HJwNEvrahF" />
</node>
</node>
</node>
</node>
</node>
<node concept="3$f86x" id="7HJwNEvoCBm" role="3$dUly">
<ref role="3$f86A" node="7HJwNEvrahF" resolve="data" />
<ref role="3$f86A" node="7HJwNEvrahF" />
</node>
</node>
</node>
Expand All @@ -1648,7 +1648,7 @@
<property role="TrG5h" value="empty_1391068388191_12" />
</node>
<node concept="3IwAZp" id="7HJwNEvrfO6" role="N3F5h">
<ref role="3IwAZn" node="6URxCt9pDSZ" resolve="Kombi" />
<ref role="3IwAZn" node="6URxCt9pDSZ" />
<node concept="3XIRFW" id="7HJwNEvrfO8" role="3IwAZC">
<node concept="3XIRlf" id="7HJwNEvrfYn" role="3XIRFZ">
<property role="TrG5h" value="s" />
Expand Down Expand Up @@ -1679,7 +1679,7 @@
<ref role="1E4Tge" node="7HJwNEvpaA9" resolve="speed" />
</node>
<node concept="3$f86x" id="7HJwNEv_9Zg" role="1_9fRO">
<ref role="3$f86A" node="7HJwNEvrahF" resolve="data" />
<ref role="3$f86A" node="7HJwNEvrahF" />
</node>
</node>
<node concept="3ZVu4v" id="7HJwNEv_9H$" role="3TlMhI">
Expand All @@ -1694,7 +1694,7 @@
<ref role="1E4Tge" node="7HJwNEvpaAb" resolve="rpm" />
</node>
<node concept="3$f86x" id="7HJwNEv_a_o" role="1_9fRO">
<ref role="3$f86A" node="7HJwNEvrahF" resolve="data" />
<ref role="3$f86A" node="7HJwNEvrahF" />
</node>
</node>
<node concept="3ZVu4v" id="7HJwNEv$MfS" role="3TlMhI">
Expand All @@ -1704,7 +1704,7 @@
</node>
</node>
<node concept="3$f86x" id="7HJwNEvrfYd" role="3$dUly">
<ref role="3$f86A" node="7HJwNEvrahF" resolve="data" />
<ref role="3$f86A" node="7HJwNEvrahF" />
</node>
</node>
<node concept="1_9egQ" id="7HJwNEv_cA9" role="3XIRFZ">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2742,10 +2742,10 @@
<node concept="2BOciq" id="6kBcLJ2m0wD" role="3Cp1j">
<node concept="2BOcij" id="6kBcLJ2mbrY" role="3TlMhJ">
<node concept="13Sk8F" id="6kBcLJ2me0d" role="3TlMhJ">
<ref role="13Sk8E" node="6kBcLJ2lj7y" resolve="temp" />
<ref role="13Sk8E" node="6kBcLJ2lj7y" />
</node>
<node concept="13Sk8F" id="6kBcLJ2m8Lz" role="3TlMhI">
<ref role="13Sk8E" node="6kBcLJ2lj7y" resolve="temp" />
<ref role="13Sk8E" node="6kBcLJ2lj7y" />
</node>
</node>
<node concept="cgjuI" id="6kBcLJ2m0wu" role="3TlMhI">
Expand Down
Loading

0 comments on commit 490985c

Please sign in to comment.