Skip to content

Commit 76e2e72

Browse files
author
Retype GitHub Action
committed
Refreshes Retype-generated documentation.
Process triggered by vfat0.
1 parent e81d9fb commit 76e2e72

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+171
-97
lines changed

‎404.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.782313449241">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.784967927027">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.6.0">
@@ -27,11 +27,11 @@
2727

2828
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
2929

30-
<link href="/resources/css/retype.css?v=3.6.0.782313449241" rel="stylesheet">
30+
<link href="/resources/css/retype.css?v=3.6.0.784967927027" rel="stylesheet">
3131

32-
<script data-cfasync="false" src="/resources/js/config.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
32+
<script data-cfasync="false" src="/resources/js/config.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
3333
<script data-cfasync="false" src="/resources/js/retype.js?v=3.6.0" data-turbo-eval="false" defer></script>
34-
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
34+
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
3535
</head>
3636
<body>
3737
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

‎audits/index.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.782313449241">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.784967927027">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.6.0">
@@ -32,11 +32,11 @@
3232

3333
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3434

35-
<link href="../resources/css/retype.css?v=3.6.0.782313449241" rel="stylesheet">
35+
<link href="../resources/css/retype.css?v=3.6.0.784967927027" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../resources/js/config.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../resources/js/config.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../resources/js/retype.js?v=3.6.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
@@ -180,10 +180,11 @@ <h1>
180180
<figcaption class="caption">yAudit</figcaption>
181181
</figure>
182182
</p>
183-
<p>The Sickle smart contracts have been audited by yAudit 3 times, please see the reports below in chronological order:</p>
183+
<p>The Sickle smart contracts have been audited by yAudit 4 times, please see the reports below in chronological order:</p>
184184
<p><a href="https://reports.yaudit.dev/reports/06-2023-Sickle/">https://reports.yaudit.dev/reports/06-2023-Sickle/</a></p>
185185
<p><a href="https://reports.yaudit.dev/reports/10-2023-Sickle-Update/">https://reports.yaudit.dev/reports/10-2023-Sickle-Update/</a></p>
186186
<p><a href="https://reports.yaudit.dev/reports/05-2024-Sickle-3/">https://reports.yaudit.dev/reports/05-2024-Sickle-3/</a></p>
187+
<p><a href="https://reports.yaudit.dev/reports/11-2024-Sickle-Strategies/">https://reports.yaudit.dev/reports/11-2024-Sickle-Strategies/</a></p>
187188
<hr>
188189
<p>LendingStrategy and SickleMultisig</p>
189190
<p><a href="https://reports.yaudit.dev/reports/06-2024-Vfat-Sickle-Multisig/">https://reports.yaudit.dev/reports/06-2024-Vfat-Sickle-Multisig/</a></p>

‎automation/compound/index.html‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.782313449241">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.784967927027">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.6.0">
@@ -21,22 +21,22 @@
2121
<meta property="og:url" content="https://docs.vfat.io/automation/compound/">
2222
<meta property="og:title" content="Automatic Compound">
2323
<meta property="og:description" content="Auto-Compound automatically compounds your positions at the optimal frequency.">
24-
<meta property="og:image" content="https://docs.vfat.io/img/automation/settings.png">
24+
<meta property="og:image" content="https://docs.vfat.io/img/automation/compound-new-position.png">
2525

2626
<!-- Twitter -->
2727
<meta property="twitter:card" content="summary_large_image">
2828
<meta property="twitter:url" content="https://docs.vfat.io/automation/compound/">
2929
<meta property="twitter:title" content="Automatic Compound">
3030
<meta property="twitter:description" content="Auto-Compound automatically compounds your positions at the optimal frequency.">
31-
<meta property="twitter:image" content="https://docs.vfat.io/img/automation/settings.png">
31+
<meta property="twitter:image" content="https://docs.vfat.io/img/automation/compound-new-position.png">
3232

3333
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3434

35-
<link href="../../resources/css/retype.css?v=3.6.0.782313449241" rel="stylesheet">
35+
<link href="../../resources/css/retype.css?v=3.6.0.784967927027" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../../resources/js/config.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../../resources/js/config.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../../resources/js/retype.js?v=3.6.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
@@ -179,26 +179,26 @@ <h1>
179179
<p>This is calculated using a simulation that takes in the position size, the APR and the current gas cost. Different frequency numbers are tested (daily, twice a day, etc.) until the best one is found. If the current rewards are higher than required by the frequency calculation, auto-compound is triggered. This simulation is done for every position each time the bot runs.</p>
180180
<p>There is a 1.8% auto-compound fee on rewards, part of which is used to pay for gas costs (no further user input needed).</p>
181181
<p>The setting can be enabled in two places:</p>
182-
<p>Firstly in the general settings (gear icon on the top right).</p>
182+
<p>Firstly when opening a new position</p>
183183
<p><figure class="content-center">
184-
<img src="../../img/automation/settings.png" alt="Settings">
185-
<figcaption class="caption">Settings</figcaption>
184+
<img src="../../img/automation/compound-new-position.png" alt="New Position">
185+
<figcaption class="caption">New Position</figcaption>
186186
</figure>
187187
</p>
188188
<p>Secondly in the Compound tab of any active position.</p>
189189
<p><figure class="content-center">
190-
<img src="../../img/automation/compound.png" alt="Compound">
191-
<figcaption class="caption">Compound</figcaption>
190+
<img src="../../img/automation/compound-tab.png" alt="Compound Tab">
191+
<figcaption class="caption">Compound Tab</figcaption>
192192
</figure>
193193
</p>
194-
<p>It is enabled once per chain and applies to all positions on that chain.</p>
194+
<p>It is enabled individually for each position.</p>
195195
<p>The general setting of Automation needs to be enabled as well, so this requires two transactions:</p>
196196
<ol type="a">
197197
<li>Enable Automation</li>
198198
<li>Enable Auto-Compound</li>
199199
</ol>
200200
<p>These can then be disabled in the general settings.</p>
201-
<p>Auto-Compound and Auto-Harvest are mutually exclusive, only one per chain can be enabled.</p>
201+
<p>Auto-Compound and Auto-Harvest are mutually exclusive, only one per each position can be enabled.</p>
202202

203203

204204
<!-- Required only on API pages -->

‎automation/harvest/index.html‎

Lines changed: 23 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,15 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.782313449241">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.784967927027">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.6.0">
1010

1111
<!-- Primary Meta Tags -->
1212
<title>Automatic Harvest</title>
1313
<meta name="title" content="Automatic Harvest">
14-
<meta name="description" content="Auto-Harvest automatically harvests your positions up to once per day, with the minimum earnings currently set to the equivalent of $50.">
14+
<meta name="description" content="Auto-Harvest automatically harvests your positions, currently each time the rewards are above the equivalent of $50.">
1515

1616
<!-- Canonical -->
1717
<link rel="canonical" href="https://docs.vfat.io/automation/harvest/">
@@ -20,23 +20,23 @@
2020
<meta property="og:type" content="website">
2121
<meta property="og:url" content="https://docs.vfat.io/automation/harvest/">
2222
<meta property="og:title" content="Automatic Harvest">
23-
<meta property="og:description" content="Auto-Harvest automatically harvests your positions up to once per day, with the minimum earnings currently set to the equivalent of $50.">
24-
<meta property="og:image" content="https://docs.vfat.io/img/automation/settings.png">
23+
<meta property="og:description" content="Auto-Harvest automatically harvests your positions, currently each time the rewards are above the equivalent of $50.">
24+
<meta property="og:image" content="https://docs.vfat.io/img/automation/harvest-new-position.png">
2525

2626
<!-- Twitter -->
2727
<meta property="twitter:card" content="summary_large_image">
2828
<meta property="twitter:url" content="https://docs.vfat.io/automation/harvest/">
2929
<meta property="twitter:title" content="Automatic Harvest">
30-
<meta property="twitter:description" content="Auto-Harvest automatically harvests your positions up to once per day, with the minimum earnings currently set to the equivalent of $50.">
31-
<meta property="twitter:image" content="https://docs.vfat.io/img/automation/settings.png">
30+
<meta property="twitter:description" content="Auto-Harvest automatically harvests your positions, currently each time the rewards are above the equivalent of $50.">
31+
<meta property="twitter:image" content="https://docs.vfat.io/img/automation/harvest-new-position.png">
3232

3333
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3434

35-
<link href="../../resources/css/retype.css?v=3.6.0.782313449241" rel="stylesheet">
35+
<link href="../../resources/css/retype.css?v=3.6.0.784967927027" rel="stylesheet">
3636

37-
<script data-cfasync="false" src="../../resources/js/config.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
37+
<script data-cfasync="false" src="../../resources/js/config.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
3838
<script data-cfasync="false" src="../../resources/js/retype.js?v=3.6.0" data-turbo-eval="false" defer></script>
39-
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
39+
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
4040
</head>
4141
<body>
4242
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">
@@ -175,29 +175,35 @@ <h1>
175175
<span>Automatic Harvest</span>
176176
</h1>
177177
</doc-anchor-target>
178-
<p>Auto-Harvest automatically harvests your positions up to once per day, with the minimum earnings currently set to the equivalent of $50.</p>
178+
<p>Auto-Harvest automatically harvests your positions, currently each time the rewards are above the equivalent of $50.</p>
179179
<p>There is a 1.2% auto-harvest fee on rewards, part of which is used to pay for gas costs (no further user input needed).</p>
180180
<p>The setting can be enabled in two places:</p>
181-
<p>Firstly in the general settings (gear icon on the top right).</p>
181+
<p>Firstly when opening a new position.</p>
182182
<p><figure class="content-center">
183-
<img src="../../img/automation/settings.png" alt="Settings">
184-
<figcaption class="caption">Settings</figcaption>
183+
<img src="../../img/automation/harvest-new-position.png" alt="New Position">
184+
<figcaption class="caption">New Position</figcaption>
185185
</figure>
186186
</p>
187187
<p>Secondly in the Harvest tab of any active position.</p>
188188
<p><figure class="content-center">
189-
<img src="../../img/automation/harvest.png" alt="Harvest">
190-
<figcaption class="caption">Harvest</figcaption>
189+
<img src="../../img/automation/harvest-tab.png" alt="Harvest Tab">
190+
<figcaption class="caption">Harvest Tab</figcaption>
191191
</figure>
192192
</p>
193-
<p>It is enabled once per chain and applies to all positions on that chain.</p>
193+
<p>You also have the option of converting the rewards to a token of your choice.</p>
194+
<p><figure class="content-center">
195+
<img src="../../img/automation/harvest-convert-rewards.png" alt="Convert Rewards">
196+
<figcaption class="caption">Convert Rewards</figcaption>
197+
</figure>
198+
</p>
199+
<p>It is enabled individually for each position.</p>
194200
<p>The general setting of Automation needs to be enabled as well, so this requires two transactions:</p>
195201
<ol type="a">
196202
<li>Enable Automation</li>
197203
<li>Enable Auto-Harvest</li>
198204
</ol>
199205
<p>These can then be disabled in the general settings.</p>
200-
<p>Auto-Harvest and Auto-Compound are mutually exclusive, only one per chain can be enabled.</p>
206+
<p>Auto-Harvest and Auto-Compound are mutually exclusive, only one per each position can be enabled.</p>
201207

202208

203209
<!-- Required only on API pages -->

‎automation/index.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width,initial-scale=1">
6-
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.782313449241">
6+
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.6.0.784967927027">
77

88
<!-- See retype.com -->
99
<meta name="generator" content="Retype 3.6.0">
@@ -30,11 +30,11 @@
3030

3131
<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>
3232

33-
<link href="../resources/css/retype.css?v=3.6.0.782313449241" rel="stylesheet">
33+
<link href="../resources/css/retype.css?v=3.6.0.784967927027" rel="stylesheet">
3434

35-
<script data-cfasync="false" src="../resources/js/config.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
35+
<script data-cfasync="false" src="../resources/js/config.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
3636
<script data-cfasync="false" src="../resources/js/retype.js?v=3.6.0" data-turbo-eval="false" defer></script>
37-
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.6.0.782313449241" data-turbo-eval="false" defer></script>
37+
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.6.0.784967927027" data-turbo-eval="false" defer></script>
3838
</head>
3939
<body>
4040
<div id="docs-app" class="relative text-base antialiased text-gray-700 bg-white font-body dark:bg-dark-850 dark:text-dark-300">

0 commit comments

Comments
 (0)