fixed links, updated text, added more contributing instructions

CONTRIBUTING.md

@@ -10,9 +10,7 @@
 
 2. **Documentation**
 
-   Any updates, typo fixes, or expansion of the documentation is more than welcome. At the moment,
-   we are using [github html preview](https://htmlpreview.github.io/?https://raw.githubusercontent.com/logicalmechanism/assist/main/docs/index.html).
-   That can be considered to be the library documentation.
+   Any updates, typo fixes, or expansion of the documentation is more than welcome. Please refer to the [online documentation](https://www.logicalmechanism.io/docs/index.html). That can be considered to be the library documentation.
 
 3. **Code**
 
@@ -32,9 +30,7 @@
 
    Please add an entry into [CHANGELOG.md](./CHANGELOG.md) when submitting changes. New entries should go into the top `# v0.x.y` section. This let's us keep track of unreleased changes for use in release notes.
 
-   Once a release is ready `# v0.x.y` gets replaced with a version number, i.e. `# v0.4.0`. Usually the maintainers will handle the section renaming along with creating a new empty `# v0.x.y` section at the top of the changelog.
-
-   Example: 
+   Example Contributions: 
 
    ```md
    # v0.x.y
@@ -44,6 +40,14 @@
    - something is gone now
    ```
 
+   Once a release is ready `# v0.x.y` gets replaced with a version number, i.e. `# v0.4.0`. Usually the maintainers will handle the section renaming along with creating a new empty `# v0.x.y` section at the top of the changelog. When releasing a new version the version number needs to be updated inside `README.md`, `aiken.toml`, and the `CHANGELOG.md`. Run the command below to do a fresh test and rebuild the docs for the final push.
+
+   ```bash
+   rm -fr build docs
+   aiken check
+   aiken docs
+   ```
+
 4. **Donation**
 
    Want to support with crypto?

README.md

@@ -13,7 +13,7 @@ To start using the library, follow these steps:
 ```toml
 [[dependencies]]
 name = "logicalmechanism/assist"
-version = "v0.4.3"
+version = "v0.4.4"
 source = "github"
 ```
 

docs/assist/addresses.html

@@ -493,8 +493,8 @@ <h2 id="from_wallet"><pre class="hljs language-aiken">from_wallet(wallet: Wallet
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/boolean.html

@@ -590,8 +590,8 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int) -&gt; Int</p
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/certificates.html

@@ -451,8 +451,8 @@ <h2 id="create_credential_delegation"><pre class="hljs language-aiken">create_cr
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/circuits.html

@@ -582,8 +582,8 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int, p: Int) -&gt
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/count.html

@@ -577,8 +577,8 @@ <h2 id="single_input_with_bypass"><pre class="hljs language-aiken">single_input_
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/credentials.html

@@ -451,8 +451,8 @@ <h2 id="create_stake_credential"><pre class="hljs language-aiken">create_stake_c
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/data.html

@@ -538,8 +538,8 @@ <h2 id="output_datum_by_hash"><pre class="hljs language-aiken">output_datum_by_h
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/find.html

@@ -691,8 +691,8 @@ <h2 id="stake_reward_by_sc"><pre class="hljs language-aiken">stake_reward_by_sc(
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/maths.html

@@ -714,8 +714,8 @@ <h2 id="to_int"><pre class="hljs language-aiken">to_int(self: ByteArray) -&gt; I
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/minting.html

@@ -510,8 +510,8 @@ <h2 id="is_occurring"><pre class="hljs language-aiken">is_occurring(
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/payout.html

@@ -499,8 +499,8 @@ <h2 id="exact"><pre class="hljs language-aiken">exact(
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/prefixes.html

@@ -532,8 +532,8 @@ <h2 id="prefix_database"><pre class="hljs language-aiken">prefix_database: ByteA
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/signing.html

@@ -474,8 +474,8 @@ <h2 id="verify_sig"><pre class="hljs language-aiken">verify_sig(vks: List&lt;Pub
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/std.html

@@ -451,8 +451,8 @@ <h2 id="out_ref"><pre class="hljs language-aiken">out_ref(tx_id_hash: ByteArray,
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/tx.html

@@ -497,8 +497,8 @@ <h2 id="total_token_amount"><pre class="hljs language-aiken">total_token_amount(
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/types/cip68.html

@@ -467,8 +467,8 @@ <h3>Constructors</h3>
       });
     </script>
     <script src="../../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../../js/index.js?v=1706570529"></script>
+    <script src="../../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../../search-data.js?v=1706570529"></script>
+    <script src="../../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/types/hashes.html

@@ -521,8 +521,8 @@ <h3>Alias</h3>
       });
     </script>
     <script src="../../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../../js/index.js?v=1706570529"></script>
+    <script src="../../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../../search-data.js?v=1706570529"></script>
+    <script src="../../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/types/moment.html

@@ -590,8 +590,8 @@ <h2 id="is_logical"><pre class="hljs language-aiken">is_logical(m: Moment) -&gt;
       });
     </script>
     <script src="../../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../../js/index.js?v=1706570529"></script>
+    <script src="../../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../../search-data.js?v=1706570529"></script>
+    <script src="../../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/types/token.html

@@ -691,8 +691,8 @@ <h2 id="subtraction_only"><pre class="hljs language-aiken">subtraction_only(toke
       });
     </script>
     <script src="../../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../../js/index.js?v=1706570529"></script>
+    <script src="../../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../../search-data.js?v=1706570529"></script>
+    <script src="../../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/types/wallet.html

@@ -499,8 +499,8 @@ <h2 id="is_valid"><pre class="hljs language-aiken">is_valid(wallet: Wallet) -&gt
       });
     </script>
     <script src="../../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../../js/index.js?v=1706570529"></script>
+    <script src="../../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../../search-data.js?v=1706570529"></script>
+    <script src="../../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/assist/values.html

@@ -600,8 +600,8 @@ <h2 id="unique_token_name"><pre class="hljs language-aiken">unique_token_name(tx
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/index.html

@@ -343,7 +343,7 @@ <h2>Getting Started</h2>
 </ol>
 <pre><code class="language-toml">[[dependencies]]
 name = &quot;logicalmechanism/assist&quot;
-version = &quot;v0.4.3&quot;
+version = &quot;v0.4.4&quot;
 source = &quot;github&quot;
 </code></pre>
 <ol start="3">
@@ -446,8 +446,8 @@ <h2>License</h2>
       });
     </script>
     <script src="./js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="./js/index.js?v=1706570529"></script>
+    <script src="./js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="./search-data.js?v=1706570529"></script>
+    <script src="./search-data.js?v=1706571404"></script>
   </body>
 </html>

docs/tests/fake_tx.html

@@ -737,8 +737,8 @@ <h2 id="test_tx"><pre class="hljs language-aiken">test_tx() -&gt; Transaction</p
       });
     </script>
     <script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
-    <script src="../js/index.js?v=1706570529"></script>
+    <script src="../js/index.js?v=1706571404"></script>
     <!-- Load the search index using JSONP to avoid CORS issues -->
-    <script src="../search-data.js?v=1706570529"></script>
+    <script src="../search-data.js?v=1706571404"></script>
   </body>
 </html>