keep3r-network · Korokoe · Oct 6, 2022 · Oct 6, 2022 · Oct 6, 2022 · Oct 10, 2022
diff --git a/docs/.gitbook/assets/image (3).png b/docs/.gitbook/assets/image (3).png
diff --git a/docs/.gitbook/assets/image (6) (1).png b/docs/.gitbook/assets/image (6) (1).png
diff --git a/docs/.gitbook/assets/image (6).png b/docs/.gitbook/assets/image (6).png
diff --git a/docs/.gitbook/assets/image (8).png b/docs/.gitbook/assets/image (8).png
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
diff --git a/docs/README.md b/docs/README.md
@@ -16,3 +16,11 @@ A Job is the term used to refer to a smart contract that wishes an external enti
 
 Credits are used to pay keepers for their work. A job can either top up your credits [with tokens](tokenomics/job-payment-mechanisms/token-payments.md), or by mining credits with time by [staking liquidity](tokenomics/job-payment-mechanisms/credit-mining.md).
 
+### Local Development
+
+```
+yarn
+yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
diff --git a/docs/babel.config.js b/docs/babel.config.js
@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};
diff --git a/docs/docs/cli/README.md b/docs/docs/cli/README.md
@@ -0,0 +1 @@
+# CLI
diff --git a/docs/cli/introduction.md → docs/docs/cli/introduction.md b/docs/cli/introduction.md → docs/docs/cli/introduction.md
diff --git a/docs/cli/jobs.md → docs/docs/cli/jobs.md b/docs/cli/jobs.md → docs/docs/cli/jobs.md
diff --git a/docs/cli/keepers.md → docs/docs/cli/keepers.md b/docs/cli/keepers.md → docs/docs/cli/keepers.md
diff --git a/docs/docs/core/README.md b/docs/docs/core/README.md
@@ -0,0 +1 @@
+# Core
diff --git a/docs/.gitbook/assets/jobmigration.png → docs/docs/core/img/jobmigration.png b/docs/.gitbook/assets/jobmigration.png → docs/docs/core/img/jobmigration.png
diff --git a/docs/core/jobs.md → docs/docs/core/jobs.md b/docs/core/jobs.md → docs/docs/core/jobs.md
@@ -218,7 +218,7 @@ There are some considerations the job wishing to migrate must take into account
 
 Here's a graphic representation to visualize the resulting changes in the credits of a job that goes through a successful migration.
 
-![](../.gitbook/assets/jobmigration.png)
+![](./img/jobmigration.png)
 
 
 
diff --git a/docs/core/keepers.md → docs/docs/core/keepers.md b/docs/core/keepers.md → docs/docs/core/keepers.md
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
@@ -0,0 +1,21 @@
+---
+sidebar_position: 1
+---
+# Introduction
+
+_These docs are in active development by the Keep3r community._
+
+The Keep3r Network is a decentralized network for projects that need external devops, and for external teams to find keeper jobs.
+
+## [Keepers](core/keepers.md)
+
+A Keeper is the term used to refer to an external address that executes a job. This can be as simplistic as calling a transaction, or as complex as requiring extensive off-chain logic. The scope of Keep3r network is not to manage these jobs themselves, but to allow contracts to register as jobs for keepers, and keepers to register themselves as available to perform jobs. It is up to the individual keeper to set up their DevOps and infrastructure and create their own rules based on what transactions they deem profitable.
+
+## [Jobs](core/jobs.md)
+
+A Job is the term used to refer to a smart contract that wishes an external entity to perform an action. They would like the action to be performed in "good will" and not have a malicious result. For this reason they register as a job, and keepers can then execute on their contract. Both relying on the Keep3r ecosystem to mediate in the event of a dispute.
+
+## [Credits](tokenomics/job-payment-mechanisms/)
+
+Credits are used to pay keepers for their work. A job can either top up your credits [with tokens](tokenomics/job-payment-mechanisms/token-payments.md), or by mining credits with time by [staking liquidity](tokenomics/job-payment-mechanisms/credit-mining.md).
+
diff --git a/docs/registry.md → docs/docs/registry.md b/docs/registry.md → docs/docs/registry.md
@@ -1,3 +1,7 @@
+---
+sidebar_position: 2
+---
+
 # Registry
 
 ## Beta Addresses

diff --git a/docs/docs/roles/README.md b/docs/docs/roles/README.md
@@ -0,0 +1,2 @@
+# Roles
+
diff --git a/docs/roles/disputer.md → docs/docs/roles/disputer.md b/docs/roles/disputer.md → docs/docs/roles/disputer.md
diff --git a/docs/roles/governance.md → docs/docs/roles/governance.md b/docs/roles/governance.md → docs/docs/roles/governance.md
diff --git a/docs/roles/slasher.md → docs/docs/roles/slasher.md b/docs/roles/slasher.md → docs/docs/roles/slasher.md
diff --git a/docs/technical/IKeep3r.md → docs/docs/technical/IKeep3r.md b/docs/technical/IKeep3r.md → docs/docs/technical/IKeep3r.md
diff --git a/docs/technical/IKeep3rHelper.md → docs/docs/technical/IKeep3rHelper.md b/docs/technical/IKeep3rHelper.md → docs/docs/technical/IKeep3rHelper.md
diff --git a/docs/technical/IKeep3rHelperParameters.md → ...docs/technical/IKeep3rHelperParameters.md b/docs/technical/IKeep3rHelperParameters.md → ...docs/technical/IKeep3rHelperParameters.md
diff --git a/docs/technical/IPairManager.md → docs/docs/technical/IPairManager.md b/docs/technical/IPairManager.md → docs/docs/technical/IPairManager.md
diff --git a/docs/technical/IPairManagerFactory.md → docs/docs/technical/IPairManagerFactory.md b/docs/technical/IPairManagerFactory.md → docs/docs/technical/IPairManagerFactory.md
diff --git a/docs/technical/IUniV3PairManager.md → docs/docs/technical/IUniV3PairManager.md b/docs/technical/IUniV3PairManager.md → docs/docs/technical/IUniV3PairManager.md
diff --git a/docs/technical/README.md → docs/docs/technical/README.md b/docs/technical/README.md → docs/docs/technical/README.md
diff --git a/docs/technical/external/IAggregatorV3.md → .../docs/technical/external/IAggregatorV3.md b/docs/technical/external/IAggregatorV3.md → .../docs/technical/external/IAggregatorV3.md
diff --git a/docs/technical/external/IKasparov.md → docs/docs/technical/external/IKasparov.md b/docs/technical/external/IKasparov.md → docs/docs/technical/external/IKasparov.md
diff --git a/docs/technical/external/IKeep3rV1.md → docs/docs/technical/external/IKeep3rV1.md b/docs/technical/external/IKeep3rV1.md → docs/docs/technical/external/IKeep3rV1.md
diff --git a/docs/technical/external/IKeep3rV1Proxy.md → ...docs/technical/external/IKeep3rV1Proxy.md b/docs/technical/external/IKeep3rV1Proxy.md → ...docs/technical/external/IKeep3rV1Proxy.md
diff --git a/docs/technical/external/IWeth9.md → docs/docs/technical/external/IWeth9.md b/docs/technical/external/IWeth9.md → docs/docs/technical/external/IWeth9.md
diff --git a/docs/technical/peripherals/IBaseErrors.md → ...docs/technical/peripherals/IBaseErrors.md b/docs/technical/peripherals/IBaseErrors.md → ...docs/technical/peripherals/IBaseErrors.md
diff --git a/docs/technical/peripherals/IDustCollector.md → ...s/technical/peripherals/IDustCollector.md b/docs/technical/peripherals/IDustCollector.md → ...s/technical/peripherals/IDustCollector.md
diff --git a/docs/technical/peripherals/IGovernable.md → ...docs/technical/peripherals/IGovernable.md b/docs/technical/peripherals/IGovernable.md → ...docs/technical/peripherals/IGovernable.md
diff --git a/...chnical/peripherals/IKeep3rAccountance.md → ...chnical/peripherals/IKeep3rAccountance.md b/...chnical/peripherals/IKeep3rAccountance.md → ...chnical/peripherals/IKeep3rAccountance.md
diff --git a/...echnical/peripherals/IKeep3rDisputable.md → ...echnical/peripherals/IKeep3rDisputable.md b/...echnical/peripherals/IKeep3rDisputable.md → ...echnical/peripherals/IKeep3rDisputable.md
diff --git a/...nical/peripherals/IKeep3rJobDisputable.md → ...nical/peripherals/IKeep3rJobDisputable.md b/...nical/peripherals/IKeep3rJobDisputable.md → ...nical/peripherals/IKeep3rJobDisputable.md
diff --git a/.../peripherals/IKeep3rJobFundableCredits.md → .../peripherals/IKeep3rJobFundableCredits.md b/.../peripherals/IKeep3rJobFundableCredits.md → .../peripherals/IKeep3rJobFundableCredits.md
diff --git a/...eripherals/IKeep3rJobFundableLiquidity.md → ...eripherals/IKeep3rJobFundableLiquidity.md b/...eripherals/IKeep3rJobFundableLiquidity.md → ...eripherals/IKeep3rJobFundableLiquidity.md
diff --git a/...echnical/peripherals/IKeep3rJobManager.md → ...echnical/peripherals/IKeep3rJobManager.md b/...echnical/peripherals/IKeep3rJobManager.md → ...echnical/peripherals/IKeep3rJobManager.md
diff --git a/...hnical/peripherals/IKeep3rJobMigration.md → ...hnical/peripherals/IKeep3rJobMigration.md b/...hnical/peripherals/IKeep3rJobMigration.md → ...hnical/peripherals/IKeep3rJobMigration.md
diff --git a/...hnical/peripherals/IKeep3rJobOwnership.md → ...hnical/peripherals/IKeep3rJobOwnership.md b/...hnical/peripherals/IKeep3rJobOwnership.md → ...hnical/peripherals/IKeep3rJobOwnership.md
diff --git a/...chnical/peripherals/IKeep3rJobWorkable.md → ...chnical/peripherals/IKeep3rJobWorkable.md b/...chnical/peripherals/IKeep3rJobWorkable.md → ...chnical/peripherals/IKeep3rJobWorkable.md
diff --git a/docs/technical/peripherals/IKeep3rJobs.md → ...docs/technical/peripherals/IKeep3rJobs.md b/docs/technical/peripherals/IKeep3rJobs.md → ...docs/technical/peripherals/IKeep3rJobs.md
diff --git a/...al/peripherals/IKeep3rKeeperDisputable.md → ...al/peripherals/IKeep3rKeeperDisputable.md b/...al/peripherals/IKeep3rKeeperDisputable.md → ...al/peripherals/IKeep3rKeeperDisputable.md
diff --git a/...ical/peripherals/IKeep3rKeeperFundable.md → ...ical/peripherals/IKeep3rKeeperFundable.md b/...ical/peripherals/IKeep3rKeeperFundable.md → ...ical/peripherals/IKeep3rKeeperFundable.md
diff --git a/docs/technical/peripherals/IKeep3rKeepers.md → ...s/technical/peripherals/IKeep3rKeepers.md b/docs/technical/peripherals/IKeep3rKeepers.md → ...s/technical/peripherals/IKeep3rKeepers.md
diff --git a/...echnical/peripherals/IKeep3rParameters.md → ...echnical/peripherals/IKeep3rParameters.md b/...echnical/peripherals/IKeep3rParameters.md → ...echnical/peripherals/IKeep3rParameters.md
diff --git a/docs/technical/peripherals/IKeep3rRoles.md → ...ocs/technical/peripherals/IKeep3rRoles.md b/docs/technical/peripherals/IKeep3rRoles.md → ...ocs/technical/peripherals/IKeep3rRoles.md
diff --git a/docs/docs/technical/peripherals/README.md b/docs/docs/technical/peripherals/README.md
@@ -0,0 +1 @@
+# Peripherals
diff --git a/docs/docs/tokenomics/README.md b/docs/docs/tokenomics/README.md
@@ -0,0 +1 @@
+# Tokenomics
diff --git a/...kenomics/job-payment-mechanisms/README.md → ...kenomics/job-payment-mechanisms/README.md b/...kenomics/job-payment-mechanisms/README.md → ...kenomics/job-payment-mechanisms/README.md
@@ -5,23 +5,23 @@ There are 2 ways for a Job Manager to pay keepers to upkeep their job:
 * Credit Mining
 * Token Payments
 
-## [Credit Mining](credit-mining.md)
+## [Credit Mining](./credit-mining.md)
 
 A Job can pay their keepers via credits obtained by Credit Mining.
 
-The Credit Mining mechanism allows anyone to provide liquidity on a [Keep3r Liquidity Pool](../keep3r-liquidity-pools.md) \(kLP\) and stake their kLP tokens on the [Keep3rJobFundableLiquidity](../../technical/peripherals/ikeep3rjobfundableliquidity.md) contract in order to start the mining of KP3R credits.
+The Credit Mining mechanism allows anyone to provide liquidity on a [Keep3r Liquidity Pool](../keep3r-liquidity-pools.md) \(kLP\) and stake their kLP tokens on the [Keep3rJobFundableLiquidity](../../technical/peripherals/IKeep3rJobFundableLiquidity.md) contract in order to start the mining of KP3R credits.
 
 The credits mined can only be used to pay for job works within the network and can't be withdrawn. 
 
 Similar to [Jobs](../../core/jobs.md) & [Keepers](../../core/keepers.md), the credits can be slashed and/or revoked via the Slasher or Governance.
 
-## [Token Payments](token-payments.md)
+## [Token Payments](./token-payments.md)
 
 A Job can pay their keepers via token payments.
 
 The token payment mechanism allows anyone to deposit ERC20s and set a rate of which they want to perform the payouts for the upkeep of their jobs.
 
-Job Managers can also add on [`directTokenPayment()`](../../technical/peripherals/ikeep3rjobworkable.md) and [`worked()`](../../technical/peripherals/ikeep3rjobworkable.md) functions on their jobs, in order for the protocol to auto-calculate their job payouts based on the amount of gas spent on the particular upkeep transaction.
+Job Managers can also add on [`directTokenPayment()`](../../technical/peripherals/IKeep3rJobWorkable.md) and [`worked()`](../../technical/peripherals/IKeep3rJobWorkable.md) functions on their jobs, in order for the protocol to auto-calculate their job payouts based on the amount of gas spent on the particular upkeep transaction.
 
 Similar to [Jobs](../../core/jobs.md) & [Keepers](../../core/keepers.md), the credits can be slashed and/or revoked via the Slasher or Governance.
 

diff --git a/...s/job-payment-mechanisms/credit-mining.md → ...s/job-payment-mechanisms/credit-mining.md b/...s/job-payment-mechanisms/credit-mining.md → ...s/job-payment-mechanisms/credit-mining.md
@@ -4,7 +4,7 @@
 
 A Job can generate new credits with time, by bonding Keep3r Liquidity Pool tokens `kLP` to it. Liquidities will be handled by the [Keep3r Liquidity Pools](../keep3r-liquidity-pools.md).
 
-Once `kLPs` are added to a job with [`addLiquidityToJob`](../../technical/peripherals/ikeep3rjobfundableliquidity.md#addliquiditytojob-address-_job-address-_liquidity-uint256-_amount-external), the job starts immediately to mine new KP3R credits, that can be collectable only by the keepers, in reward for working the job. The credit mining system requires no further action from the `jobOwner`.
+Once `kLPs` are added to a job with [`addLiquidityToJob`](../../technical/peripherals/IKeep3rJobFundableLiquidity.md#addliquiditytojob-address-_job-address-_liquidity-uint256-_amount-external), the job starts immediately to mine new KP3R credits, that can be collectable only by the keepers, in reward for working the job. The credit mining system requires no further action from the `jobOwner`.
 
 {% hint style="info" %}
 KP3R Credits can only be rewarded within the protocol, requiring an unbonding period that gives time to disputers to detect keepers and jobs that act in bad faith
@@ -14,9 +14,9 @@ KP3R Credits can only be rewarded within the protocol, requiring an unbonding pe
 
 To handle KP3R credits minting and quoting, **Keep3r introduces reward periods, in which KP3R quote remains stable for each pair, and gas-efficiently processed**. These quotes are used within the protocol to mint credits and reward keepers.
 
-The underlying KP3R of the liquidity provided, should generate the same amount of KP3R every [`inflationPeriod`](../../technical/peripherals/ikeep3rparameters.md#inflationperiod-uint256-_period-external), thereby minting the proportional amount each [`rewardPeriod`](../../technical/peripherals/ikeep3rparameters.md#rewardperiodtime-uint256-_days-external) as KP3R credits for the job. These credits are only to be earned by keepers when working the job, and by the end of each `rewardPeriod`, unused credits older than previous `rewardPeriodStart` are meant to expire.
+The underlying KP3R of the liquidity provided, should generate the same amount of KP3R every [`inflationPeriod`](../../technical/peripherals/IKeep3rParameters.md#inflationperiod-uint256-_period-external), thereby minting the proportional amount each [`rewardPeriod`](../../technical/peripherals/IKeep3rParameters.md#rewardperiodtime-uint256-_days-external) as KP3R credits for the job. These credits are only to be earned by keepers when working the job, and by the end of each `rewardPeriod`, unused credits older than previous `rewardPeriodStart` are meant to expire.
 
-![Credit mining without work](../../.gitbook/assets/image%20%284%29.png)
+![Credit mining without work](./img/image-4.png)
 
 When a new `rewardPeriod` starts, the first keeper to work the first job will:
 
@@ -37,23 +37,23 @@ A `worked()` transaction that has to update quotes and reward the job is more ga
 
 To determine the value of a certain liquidity, Keep3r uses a TWAP calculation to get the average quote of a pair in the last completed period. The same calculation is applied to quote rewards for keepers \(that spend gas in ETH and receive KP3R rewards\), using a predefined KP3R/WETH pool as an oracle.
 
-* A job will mint the result of [`quoteLiquidity`](../../technical/peripherals/ikeep3rjobfundableliquidity.md#quoteliquidity-address-_liquidity-uint256-_amount-uint256-_periodcredits-external) every `rewardPeriodTime` 
+* A job will mint the result of [`quoteLiquidity`](../../technical/peripherals/IKeep3rJobFundableLiquidity.md#quoteliquidity-address-_liquidity-uint256-_amount-uint256-_periodcredits-external) every `rewardPeriodTime` 
 * `quoteLiquidity` will use the average quote for the last `epoch`for the given liquidity
 * Remaining credits will be updated to current quotes each time a `rewardPeriod` starts
 
 #### Job Credit accountance
 
-At every time, a job will have its **current credits** \(already rewarded and stored as [`jobLiquidityCredits`](../../technical/peripherals/ikeep3rjobfundableliquidity.md#jobperiodcredits-address-_job-uint256-_amount-external)\) and **pending mined credits** to be rewarded \(aggregated with current credits in [`totalJobCredits`](../../technical/peripherals/ikeep3rjobfundableliquidity.md#totaljobcredits-address-_job-uint256-_amount-external)\). 
+At every time, a job will have its **current credits** \(already rewarded and stored as [`jobLiquidityCredits`](../../technical/peripherals/IKeep3rJobFundableLiquidity.md#jobperiodcredits-address-_job-uint256-_amount-external)\) and **pending mined credits** to be rewarded \(aggregated with current credits in [`totalJobCredits`](../../technical/peripherals/IKeep3rJobFundableLiquidity.md#totaljobcredits-address-_job-uint256-_amount-external)\). 
 
 A keeper will be able to run the job, as long as `totalJobCredits` is greater than the payment. If `jobLiquidityCredits` are not enough to pay the keeper, then the keeper will have to reward the job by rewarding the job with its mined credits.
 
 In a normal case scenario, a job should be rewarded once every reward period starts, and burn all remaining credits from the expired period \(the one previous to the last full period\). 
 
-![Normal case scenario](../../.gitbook/assets/image%20%289%29.png)
+![Normal case scenario](./img/image-9.png)
 
 In a deficitary job scenario, when the job is spending more KP3R in a period than it should be rewarded, the job will be able to keep on paying keepers, but the minting period will start to shrink, having to mint more frequently.
 
-![Deficitary job scenario](../../.gitbook/assets/image%20%287%29.png)
+![Deficitary job scenario](./img/image-7.png)
 
 Each time, the reward period will be shorter, as the job is not being rewarded the full amount for a period, but only the proportional relation of the time that passed since the last reward, and the `rewardPeriod`.
 
@@ -63,17 +63,17 @@ Ultimately, when the job has not enough `totalJobCredits` to reward the keeper f
 
 At particular times, a job can make a payment of up to 2 times its `jobPeriodCredits`, as long as all the credits minted have not yet expired. 
 
-![Credits spending greater than jobPeriodCredits](../../.gitbook/assets/image%20%282%29.png)
+![Credits spending greater than jobPeriodCredits](./img/image-2.png)
 
 **Updating Credits**
 
-Since quotes can change every epoch, Keep3r recalculates every period how many KP3R a job should be mined each period, aggregated by [`jobPeriodCredits`](../../technical/peripherals/ikeep3rjobfundableliquidity.md#jobperiodcredits-address-_job-uint256-_amount-external).
+Since quotes can change every epoch, Keep3r recalculates every period how many KP3R a job should be mined each period, aggregated by [`jobPeriodCredits`](../../technical/peripherals/IKeep3rJobFundableLiquidity.md#jobperiodcredits-address-_job-uint256-_amount-external).
 
-![Credit mining with quote change](../../.gitbook/assets/image%20%285%29.png)
+![Credit mining with quote change](./img/image-5.png)
 
 Since KP3R/WETH is also stored and **stable inside periods**, keeper payments are also updated to current quotes.
 
-![Work scenario with quote change](../../.gitbook/assets/image%20%281%29.png)
+![Work scenario with quote change](./img/image-1.png)
 
 #### Removing Liquidity
 

diff --git a/docs/.gitbook/assets/image (1).png → ...cs/job-payment-mechanisms/img/image-1.png b/docs/.gitbook/assets/image (1).png → ...cs/job-payment-mechanisms/img/image-1.png
diff --git a/docs/.gitbook/assets/image (2).png → ...cs/job-payment-mechanisms/img/image-2.png b/docs/.gitbook/assets/image (2).png → ...cs/job-payment-mechanisms/img/image-2.png
diff --git a/docs/.gitbook/assets/image (4).png → ...cs/job-payment-mechanisms/img/image-4.png b/docs/.gitbook/assets/image (4).png → ...cs/job-payment-mechanisms/img/image-4.png
diff --git a/docs/.gitbook/assets/image (5).png → ...cs/job-payment-mechanisms/img/image-5.png b/docs/.gitbook/assets/image (5).png → ...cs/job-payment-mechanisms/img/image-5.png
diff --git a/docs/.gitbook/assets/image (7).png → ...cs/job-payment-mechanisms/img/image-7.png b/docs/.gitbook/assets/image (7).png → ...cs/job-payment-mechanisms/img/image-7.png
diff --git a/docs/.gitbook/assets/image (9).png → ...cs/job-payment-mechanisms/img/image-9.png b/docs/.gitbook/assets/image (9).png → ...cs/job-payment-mechanisms/img/image-9.png
diff --git a/.../job-payment-mechanisms/token-payments.md → .../job-payment-mechanisms/token-payments.md b/.../job-payment-mechanisms/token-payments.md → .../job-payment-mechanisms/token-payments.md
diff --git a/docs/tokenomics/keep3r-liquidity-pools.md → ...docs/tokenomics/keep3r-liquidity-pools.md b/docs/tokenomics/keep3r-liquidity-pools.md → ...docs/tokenomics/keep3r-liquidity-pools.md
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -0,0 +1,67 @@
+// @ts-check
+// Note: type annotations allow type checking and IDEs autocompletion
+
+const lightCodeTheme = require('prism-react-renderer/themes/github');
+const darkCodeTheme = require('prism-react-renderer/themes/dracula');
+
+/** @type {import('@docusaurus/types').Config} */
+const config = {
+  title: 'The Keep3r Network',
+  tagline: 'All the Jobs That’s Fit to Network.',
+  url: 'https://keep3r.network/',
+  baseUrl: '/',
+  onBrokenLinks: 'throw',
+  onBrokenMarkdownLinks: 'warn',
+  favicon: 'img/favicon.ico',
+  noIndex: true,
+  i18n: {
+    defaultLocale: 'en',
+    locales: ['en'],
+  },
+
+  presets: [
+    [
+      'classic',
+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({
+        docs: {
+          sidebarPath: require.resolve('./sidebars.js'),
+          editUrl: 'https://github.com/keep3r-network/keep3r-network-v2',
+        },
+        theme: {
+          customCss: require.resolve('./src/css/custom.css'),
+        },
+      }),
+    ],
+  ],
+
+  themeConfig:
+    /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+    ({
+      colorMode: {
+        defaultMode: 'dark',
+        disableSwitch: true,
+        respectPrefersColorScheme: false,
+      },
+      navbar: {
+        title: 'Keep3r',
+        logo: {
+          alt: 'Keep3r',
+          src: 'img/logo.svg',
+        },
+        items: [
+          {
+            href: 'https://github.com/facebook/docusaurus',
+            label: 'GitHub',
+            position: 'right',
+          },
+        ],
+      },
+      prism: {
+        theme: lightCodeTheme,
+        darkTheme: darkCodeTheme,
+      },
+    }),
+};
+
+module.exports = config;
diff --git a/docs/package.json b/docs/package.json
@@ -0,0 +1,43 @@
+{
+  "name": "keepr-doc",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "docusaurus": "docusaurus",
+    "start": "docusaurus start",
+    "build": "docusaurus build",
+    "swizzle": "docusaurus swizzle",
+    "deploy": "docusaurus deploy",
+    "clear": "docusaurus clear",
+    "serve": "docusaurus serve",
+    "write-translations": "docusaurus write-translations",
+    "write-heading-ids": "docusaurus write-heading-ids"
+  },
+  "dependencies": {
+    "@docusaurus/core": "2.1.0",
+    "@docusaurus/preset-classic": "2.1.0",
+    "@mdx-js/react": "^1.6.22",
+    "clsx": "^1.2.1",
+    "prism-react-renderer": "^1.3.5",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2"
+  },
+  "devDependencies": {
+    "@docusaurus/module-type-aliases": "2.1.0"
+  },
+  "browserslist": {
+    "production": [
+      ">0.5%",
+      "not dead",
+      "not op_mini all"
+    ],
+    "development": [
+      "last 1 chrome version",
+      "last 1 firefox version",
+      "last 1 safari version"
+    ]
+  },
+  "engines": {
+    "node": ">=16.14"
+  }
+}
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -0,0 +1,35 @@
+/**
+ * Creating a sidebar enables you to:
+ - create an ordered group of docs
+ - render a sidebar for each doc of that group
+ - provide next/previous navigation
+
+ The sidebars can be generated from the filesystem, or explicitly defined here.
+
+ Create as many sidebars as you want.
+ */
+
+// @ts-check
+
+/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
+const sidebars = {
+  // By default, Docusaurus generates a sidebar from the docs folder structure
+  // sidebar: [{type: 'autogenerated', dirName: '.'}],
+
+  // But you can create a sidebar manually
+  sidebar: [
+    {type: 'autogenerated', dirName: '.'},
+    {
+      type: 'link',
+      label: 'Github',
+      href: 'https://github.com/keep3r-network/keep3r-network-v2',
+      className: 'sidebarspace',
+    }, {
+      type: 'link',
+      label: 'Keep3r V1 Docs',
+      href: 'https://v1.docs.keep3r.network/',
+    },
+  ],
+};
+
+module.exports = sidebars;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -218,7 +218,7 @@ There are some considerations the job wishing to migrate must take into account

		Here's a graphic representation to visualize the resulting changes in the credits of a job that goes through a successful migration.

		![](../.gitbook/assets/jobmigration.png)
		![](./img/jobmigration.png)