Update docs

atomvm · Oct 22, 2023 · 736d48d · 736d48d
1 parent 1fae712
commit 736d48d
Show file tree

Hide file tree

Showing 16 changed files with 70 additions and 64 deletions.
diff --git a/www/404.html b/www/404.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>
 

diff --git a/www/api-reference.html b/www/api-reference.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>
 

diff --git a/www/atomvm_packbeam.epub b/www/atomvm_packbeam.epub
diff --git a/www/changelog.html b/www/changelog.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>
 
@@ -121,7 +121,13 @@ <h1>
 </h1>
 
 <p>All notable changes to this project will be documented in this file.</p><p>The format is based on <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
-and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p><h2 id="0-7-0" class="section-heading">
+and this project adheres to <a href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p><h2 id="0-7-1-unreleased" class="section-heading">
+  <a href="#0-7-1-unreleased" class="hover-link">
+    <i class="ri-link-m" aria-hidden="true"></i>
+  </a>
+  <span class="text">[0.7.1] (unreleased)</span>
+</h2>
+<ul><li>Enhanced <a href="packbeam_api.html"><code class="inline">packbeam_api</code></a> to make it more maintainable.</li><li>Changed documentation to use <a href="https://hexdocs.pm/rebar3_ex_doc/readme.html"><code class="inline">rebar3_ex_doc</code></a></li></ul><h2 id="0-7-0" class="section-heading">
   <a href="#0-7-0" class="hover-link">
     <i class="ri-link-m" aria-hidden="true"></i>
   </a>

diff --git a/www/code_of_conduct.html b/www/code_of_conduct.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>
 

diff --git a/www/contributing.html b/www/contributing.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>
 
@@ -142,19 +142,19 @@ <h3 id="c-code" class="section-heading">
   </a>
   <span class="text">C Code</span>
 </h3>
-<h4>Identation</h4><ul><li><a href="https://en.wikipedia.org/wiki/Indentation_style#K&R_style">K&amp;R identation and braces style</a></li><li><a href="https://en.wikipedia.org/wiki/Indentation_style#Variant:_mandatory_braces">Mandatory braces</a></li><li>4 spaces identation</li></ul><p>Good:</p><pre><code class="makeup erlang" translate="no"><span class="ss">void</span><span class="w"> </span><span class="nf">f</span><span class="p" data-group-id="9025031640-1">(</span><span class="ss">int</span><span class="w"> </span><span class="ss">reverse</span><span class="p" data-group-id="9025031640-1">)</span><span class="w">
-</span><span class="p" data-group-id="9025031640-2">{</span><span class="w">
-    </span><span class="nf">if</span><span class="w"> </span><span class="p" data-group-id="9025031640-3">(</span><span class="ss">reverse</span><span class="p" data-group-id="9025031640-3">)</span><span class="w"> </span><span class="p" data-group-id="9025031640-4">{</span><span class="w">
-        </span><span class="nf">puts</span><span class="p" data-group-id="9025031640-5">(</span><span class="s">&quot;!dlroW olleH&quot;</span><span class="p" data-group-id="9025031640-5">)</span><span class="p">;</span><span class="w">
-    </span><span class="p" data-group-id="9025031640-4">}</span><span class="w"> </span><span class="ss">else</span><span class="w"> </span><span class="p" data-group-id="9025031640-6">{</span><span class="w">
-        </span><span class="nf">puts</span><span class="p" data-group-id="9025031640-7">(</span><span class="s">&quot;Hello world&quot;</span><span class="p" data-group-id="9025031640-7">)</span><span class="p">;</span><span class="w">
-    </span><span class="p" data-group-id="9025031640-6">}</span><span class="w">
-</span><span class="p" data-group-id="9025031640-2">}</span></code></pre><p>Bad:</p><pre><code class="makeup erlang" translate="no"><span class="ss">void</span><span class="w"> </span><span class="nf">f</span><span class="p" data-group-id="0139387621-1">(</span><span class="ss">int</span><span class="w"> </span><span class="ss">reverse</span><span class="p" data-group-id="0139387621-1">)</span><span class="w"> </span><span class="p" data-group-id="0139387621-2">{</span><span class="w">
-    </span><span class="nf">if</span><span class="w"> </span><span class="p" data-group-id="0139387621-3">(</span><span class="ss">reverse</span><span class="p" data-group-id="0139387621-3">)</span><span class="w">
-        </span><span class="nf">puts</span><span class="w"> </span><span class="p" data-group-id="0139387621-4">(</span><span class="s">&quot;!dlroW olleH&quot;</span><span class="p" data-group-id="0139387621-4">)</span><span class="p">;</span><span class="w">
+<h4>Identation</h4><ul><li><a href="https://en.wikipedia.org/wiki/Indentation_style#K&R_style">K&amp;R identation and braces style</a></li><li><a href="https://en.wikipedia.org/wiki/Indentation_style#Variant:_mandatory_braces">Mandatory braces</a></li><li>4 spaces identation</li></ul><p>Good:</p><pre><code class="makeup erlang" translate="no"><span class="ss">void</span><span class="w"> </span><span class="nf">f</span><span class="p" data-group-id="3589665544-1">(</span><span class="ss">int</span><span class="w"> </span><span class="ss">reverse</span><span class="p" data-group-id="3589665544-1">)</span><span class="w">
+</span><span class="p" data-group-id="3589665544-2">{</span><span class="w">
+    </span><span class="nf">if</span><span class="w"> </span><span class="p" data-group-id="3589665544-3">(</span><span class="ss">reverse</span><span class="p" data-group-id="3589665544-3">)</span><span class="w"> </span><span class="p" data-group-id="3589665544-4">{</span><span class="w">
+        </span><span class="nf">puts</span><span class="p" data-group-id="3589665544-5">(</span><span class="s">&quot;!dlroW olleH&quot;</span><span class="p" data-group-id="3589665544-5">)</span><span class="p">;</span><span class="w">
+    </span><span class="p" data-group-id="3589665544-4">}</span><span class="w"> </span><span class="ss">else</span><span class="w"> </span><span class="p" data-group-id="3589665544-6">{</span><span class="w">
+        </span><span class="nf">puts</span><span class="p" data-group-id="3589665544-7">(</span><span class="s">&quot;Hello world&quot;</span><span class="p" data-group-id="3589665544-7">)</span><span class="p">;</span><span class="w">
+    </span><span class="p" data-group-id="3589665544-6">}</span><span class="w">
+</span><span class="p" data-group-id="3589665544-2">}</span></code></pre><p>Bad:</p><pre><code class="makeup erlang" translate="no"><span class="ss">void</span><span class="w"> </span><span class="nf">f</span><span class="p" data-group-id="1087426546-1">(</span><span class="ss">int</span><span class="w"> </span><span class="ss">reverse</span><span class="p" data-group-id="1087426546-1">)</span><span class="w"> </span><span class="p" data-group-id="1087426546-2">{</span><span class="w">
+    </span><span class="nf">if</span><span class="w"> </span><span class="p" data-group-id="1087426546-3">(</span><span class="ss">reverse</span><span class="p" data-group-id="1087426546-3">)</span><span class="w">
+        </span><span class="nf">puts</span><span class="w"> </span><span class="p" data-group-id="1087426546-4">(</span><span class="s">&quot;!dlroW olleH&quot;</span><span class="p" data-group-id="1087426546-4">)</span><span class="p">;</span><span class="w">
     </span><span class="ss">else</span><span class="w">
-        </span><span class="nf">puts</span><span class="w"> </span><span class="p" data-group-id="0139387621-5">(</span><span class="s">&quot;Hello world&quot;</span><span class="p" data-group-id="0139387621-5">)</span><span class="p">;</span><span class="w">
-</span><span class="p" data-group-id="0139387621-2">}</span></code></pre><h4>Names</h4><ul><li>Struct names are PascalCase (e.g. Context)</li><li>Scalar types are lower case (e.g. term)</li><li>All other names (e.g. functions and variables) are snake_case (e.g. term_is_integer)</li><li>Always prefix function names (e.g. term_is_nil, term_is_integer, context_new, context_destroy)</li></ul><h4>Other Coding Conventions</h4><ul><li>Pointer <em> should be with the variable name rather than with the type (e.g. `char </em>name<code class="inline">, not</code>char* name`)</li><li>Avoid long lines, use intermediate variables with meaningful names.</li></ul><h3 id="elixir-code" class="section-heading">
+        </span><span class="nf">puts</span><span class="w"> </span><span class="p" data-group-id="1087426546-5">(</span><span class="s">&quot;Hello world&quot;</span><span class="p" data-group-id="1087426546-5">)</span><span class="p">;</span><span class="w">
+</span><span class="p" data-group-id="1087426546-2">}</span></code></pre><h4>Names</h4><ul><li>Struct names are PascalCase (e.g. Context)</li><li>Scalar types are lower case (e.g. term)</li><li>All other names (e.g. functions and variables) are snake_case (e.g. term_is_integer)</li><li>Always prefix function names (e.g. term_is_nil, term_is_integer, context_new, context_destroy)</li></ul><h4>Other Coding Conventions</h4><ul><li>Pointer <em> should be with the variable name rather than with the type (e.g. `char </em>name<code class="inline">, not</code>char* name`)</li><li>Avoid long lines, use intermediate variables with meaningful names.</li></ul><h3 id="elixir-code" class="section-heading">
   <a href="#elixir-code" class="hover-link">
     <i class="ri-link-m" aria-hidden="true"></i>
   </a>

diff --git a/www/dist/search_data-01CBC306.js b/www/dist/search_data-01CBC306.js
diff --git a/www/dist/search_data-BA62C2F8.js b/www/dist/search_data-BA62C2F8.js
diff --git a/www/dist/sidebar_items-1CC8F05C.js b/www/dist/sidebar_items-1CC8F05C.js
diff --git a/www/dist/sidebar_items-77191197.js b/www/dist/sidebar_items-77191197.js
diff --git a/www/license.html b/www/license.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>
 

diff --git a/www/packbeam.html b/www/packbeam.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>
 

diff --git a/www/packbeam_api.html b/www/packbeam_api.html
@@ -13,7 +13,7 @@
 
     <script src="dist/handlebars.runtime-NWIB6V2M.js"></script>
     <script src="dist/handlebars.templates-EPF2X7PV.js"></script>
-    <script src="dist/sidebar_items-77191197.js"></script>
+    <script src="dist/sidebar_items-1CC8F05C.js"></script>
 
       <script src="docs_config.js"></script>