Skip to content

Commit ff7c245

Browse files
logicalmechanismlogicalmechanism
authored
Merge pull request #71 from logicalmechanism/readme-chores-1
fixed links, updated text, added more contributing instructions
2 parents 4b5626c + a4a22fc commit ff7c245

26 files changed

+59
-55
lines changed

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,7 @@
1010

1111
2. **Documentation**
1212

13-
Any updates, typo fixes, or expansion of the documentation is more than welcome. At the moment,
14-
we are using [github html preview](https://htmlpreview.github.io/?https://raw.githubusercontent.com/logicalmechanism/assist/main/docs/index.html).
15-
That can be considered to be the library documentation.
13+
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.
1614

1715
3. **Code**
1816

@@ -32,9 +30,7 @@
3230

3331
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.
3432

35-
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.
36-
37-
Example:
33+
Example Contributions:
3834

3935
```md
4036
# v0.x.y
@@ -44,6 +40,14 @@
4440
- something is gone now
4541
```
4642

43+
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.
44+
45+
```bash
46+
rm -fr build docs
47+
aiken check
48+
aiken docs
49+
```
50+
4751
4. **Donation**
4852

4953
Want to support with crypto?

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To start using the library, follow these steps:
1313
```toml
1414
[[dependencies]]
1515
name = "logicalmechanism/assist"
16-
version = "v0.4.3"
16+
version = "v0.4.4"
1717
source = "github"
1818
```
1919

‎docs/assist/addresses.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -493,8 +493,8 @@ <h2 id="from_wallet"><pre class="hljs language-aiken">from_wallet(wallet: Wallet
493493
});
494494
</script>
495495
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
496-
<script src="../js/index.js?v=1706570529"></script>
496+
<script src="../js/index.js?v=1706571404"></script>
497497
<!-- Load the search index using JSONP to avoid CORS issues -->
498-
<script src="../search-data.js?v=1706570529"></script>
498+
<script src="../search-data.js?v=1706571404"></script>
499499
</body>
500500
</html>

‎docs/assist/boolean.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,8 +590,8 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int) -&gt; Int</p
590590
});
591591
</script>
592592
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
593-
<script src="../js/index.js?v=1706570529"></script>
593+
<script src="../js/index.js?v=1706571404"></script>
594594
<!-- Load the search index using JSONP to avoid CORS issues -->
595-
<script src="../search-data.js?v=1706570529"></script>
595+
<script src="../search-data.js?v=1706571404"></script>
596596
</body>
597597
</html>

‎docs/assist/certificates.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,8 @@ <h2 id="create_credential_delegation"><pre class="hljs language-aiken">create_cr
451451
});
452452
</script>
453453
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
454-
<script src="../js/index.js?v=1706570529"></script>
454+
<script src="../js/index.js?v=1706571404"></script>
455455
<!-- Load the search index using JSONP to avoid CORS issues -->
456-
<script src="../search-data.js?v=1706570529"></script>
456+
<script src="../search-data.js?v=1706571404"></script>
457457
</body>
458458
</html>

‎docs/assist/circuits.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -582,8 +582,8 @@ <h2 id="xor_"><pre class="hljs language-aiken">xor_(x: Int, y: Int, p: Int) -&gt
582582
});
583583
</script>
584584
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
585-
<script src="../js/index.js?v=1706570529"></script>
585+
<script src="../js/index.js?v=1706571404"></script>
586586
<!-- Load the search index using JSONP to avoid CORS issues -->
587-
<script src="../search-data.js?v=1706570529"></script>
587+
<script src="../search-data.js?v=1706571404"></script>
588588
</body>
589589
</html>

‎docs/assist/count.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -577,8 +577,8 @@ <h2 id="single_input_with_bypass"><pre class="hljs language-aiken">single_input_
577577
});
578578
</script>
579579
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
580-
<script src="../js/index.js?v=1706570529"></script>
580+
<script src="../js/index.js?v=1706571404"></script>
581581
<!-- Load the search index using JSONP to avoid CORS issues -->
582-
<script src="../search-data.js?v=1706570529"></script>
582+
<script src="../search-data.js?v=1706571404"></script>
583583
</body>
584584
</html>

‎docs/assist/credentials.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -451,8 +451,8 @@ <h2 id="create_stake_credential"><pre class="hljs language-aiken">create_stake_c
451451
});
452452
</script>
453453
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
454-
<script src="../js/index.js?v=1706570529"></script>
454+
<script src="../js/index.js?v=1706571404"></script>
455455
<!-- Load the search index using JSONP to avoid CORS issues -->
456-
<script src="../search-data.js?v=1706570529"></script>
456+
<script src="../search-data.js?v=1706571404"></script>
457457
</body>
458458
</html>

‎docs/assist/data.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -538,8 +538,8 @@ <h2 id="output_datum_by_hash"><pre class="hljs language-aiken">output_datum_by_h
538538
});
539539
</script>
540540
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
541-
<script src="../js/index.js?v=1706570529"></script>
541+
<script src="../js/index.js?v=1706571404"></script>
542542
<!-- Load the search index using JSONP to avoid CORS issues -->
543-
<script src="../search-data.js?v=1706570529"></script>
543+
<script src="../search-data.js?v=1706571404"></script>
544544
</body>
545545
</html>

‎docs/assist/find.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -691,8 +691,8 @@ <h2 id="stake_reward_by_sc"><pre class="hljs language-aiken">stake_reward_by_sc(
691691
});
692692
</script>
693693
<script src="../js/lunr.min.js?v=1.0.23-alpha"></script>
694-
<script src="../js/index.js?v=1706570529"></script>
694+
<script src="../js/index.js?v=1706571404"></script>
695695
<!-- Load the search index using JSONP to avoid CORS issues -->
696-
<script src="../search-data.js?v=1706570529"></script>
696+
<script src="../search-data.js?v=1706571404"></script>
697697
</body>
698698
</html>

0 commit comments

Comments
 (0)