Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

AsciiDoc documentation and CI/CD workflow #95

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

AsciiDoc documentation and CI/CD workflow #95

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7047d7d
AsciiDoc documentation and CI/CD workflow
christoph2806 Jan 30, 2023
ddc1906
Update package-lock.json
christoph2806 Jan 30, 2023
85f9e15
Add cleaned up package.json to /contracts
christoph2806 Jan 30, 2023
e7a7fcf
rm /contracts/package.json
christoph2806 Jan 30, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 1 addition & 5 deletions docs/modules/api/pages/flows.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,13 @@ NOTE: This document is better viewed at https://docs.etherisc.com/contracts/api/

[.contract]
[[PolicyDefaultFlow]]
=== `++PolicyDefaultFlow++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/flows/PolicyDefaultFlow.sol[{github-icon},role=heading-link]
=== `++PolicyDefaultFlow++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/flows/PolicyDefaultFlow.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@etherisc/gif-contracts/contracts/flows/PolicyDefaultFlow.sol";
```

This contract defines the high-level lifecycle of a policy.

The contract ensures that all state transistions are always valid.

[.contract-index]
.Modifiers
--
Expand Down
35 changes: 21 additions & 14 deletions docs/modules/api/pages/modules.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,8 @@
:xref-CoreController-_getContractAddress-bytes32-: xref:shared.adoc#CoreController-_getContractAddress-bytes32-
:xref-PoolController-onlyInstanceOperatorService--: xref:modules.adoc#PoolController-onlyInstanceOperatorService--
:xref-PoolController-onlyRiskpoolService--: xref:modules.adoc#PoolController-onlyRiskpoolService--
:xref-PoolController-onlyTreasury--: xref:modules.adoc#PoolController-onlyTreasury--
:xref-PoolController-onlyActivePool-uint256-: xref:modules.adoc#PoolController-onlyActivePool-uint256-
:xref-PoolController-onlyActivePoolForProcess-bytes32-: xref:modules.adoc#PoolController-onlyActivePoolForProcess-bytes32-
:xref-PoolController-_afterInitialize--: xref:modules.adoc#PoolController-_afterInitialize--
:xref-PoolController-registerRiskpool-uint256-address-address-uint256-uint256-: xref:modules.adoc#PoolController-registerRiskpool-uint256-address-address-uint256-uint256-
:xref-PoolController-setRiskpoolForProduct-uint256-uint256-: xref:modules.adoc#PoolController-setRiskpoolForProduct-uint256-uint256-
Expand Down Expand Up @@ -235,7 +236,7 @@ NOTE: This document is better viewed at https://docs.etherisc.com/contracts/api/

[.contract]
[[AccessController]]
=== `++AccessController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/AccessController.sol[{github-icon},role=heading-link]
=== `++AccessController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/AccessController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -425,7 +426,7 @@ import "@etherisc/gif-contracts/contracts/modules/AccessController.sol";

[.contract]
[[BundleController]]
=== `++BundleController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/BundleController.sol[{github-icon},role=heading-link]
=== `++BundleController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/BundleController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -653,7 +654,7 @@ import "@etherisc/gif-contracts/contracts/modules/BundleController.sol";

[.contract]
[[ComponentController]]
=== `++ComponentController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/ComponentController.sol[{github-icon},role=heading-link]
=== `++ComponentController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/ComponentController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -872,7 +873,7 @@ import "@etherisc/gif-contracts/contracts/modules/ComponentController.sol";

[.contract]
[[LicenseController]]
=== `++LicenseController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/LicenseController.sol[{github-icon},role=heading-link]
=== `++LicenseController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/LicenseController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -968,7 +969,7 @@ import "@etherisc/gif-contracts/contracts/modules/LicenseController.sol";

[.contract]
[[PolicyController]]
=== `++PolicyController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/PolicyController.sol[{github-icon},role=heading-link]
=== `++PolicyController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/PolicyController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -1159,7 +1160,8 @@ import "@etherisc/gif-contracts/contracts/modules/PolicyController.sol";
:DEFAULT_MAX_NUMBER_OF_ACTIVE_BUNDLES: pass:normal[xref:#PoolController-DEFAULT_MAX_NUMBER_OF_ACTIVE_BUNDLES-uint256[`++DEFAULT_MAX_NUMBER_OF_ACTIVE_BUNDLES++`]]
:onlyInstanceOperatorService: pass:normal[xref:#PoolController-onlyInstanceOperatorService--[`++onlyInstanceOperatorService++`]]
:onlyRiskpoolService: pass:normal[xref:#PoolController-onlyRiskpoolService--[`++onlyRiskpoolService++`]]
:onlyTreasury: pass:normal[xref:#PoolController-onlyTreasury--[`++onlyTreasury++`]]
:onlyActivePool: pass:normal[xref:#PoolController-onlyActivePool-uint256-[`++onlyActivePool++`]]
:onlyActivePoolForProcess: pass:normal[xref:#PoolController-onlyActivePoolForProcess-bytes32-[`++onlyActivePoolForProcess++`]]
:_afterInitialize: pass:normal[xref:#PoolController-_afterInitialize--[`++_afterInitialize++`]]
:registerRiskpool: pass:normal[xref:#PoolController-registerRiskpool-uint256-address-address-uint256-uint256-[`++registerRiskpool++`]]
:setRiskpoolForProduct: pass:normal[xref:#PoolController-setRiskpoolForProduct-uint256-uint256-[`++setRiskpoolForProduct++`]]
Expand All @@ -1185,7 +1187,7 @@ import "@etherisc/gif-contracts/contracts/modules/PolicyController.sol";

[.contract]
[[PoolController]]
=== `++PoolController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/PoolController.sol[{github-icon},role=heading-link]
=== `++PoolController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/PoolController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand All @@ -1197,7 +1199,8 @@ import "@etherisc/gif-contracts/contracts/modules/PoolController.sol";
--
* {xref-PoolController-onlyInstanceOperatorService--}[`++onlyInstanceOperatorService()++`]
* {xref-PoolController-onlyRiskpoolService--}[`++onlyRiskpoolService()++`]
* {xref-PoolController-onlyTreasury--}[`++onlyTreasury()++`]
* {xref-PoolController-onlyActivePool-uint256-}[`++onlyActivePool(riskpoolId)++`]
* {xref-PoolController-onlyActivePoolForProcess-bytes32-}[`++onlyActivePoolForProcess(processId)++`]
--

[.contract-index]
Expand Down Expand Up @@ -1271,8 +1274,12 @@ import "@etherisc/gif-contracts/contracts/modules/PoolController.sol";
==== `[.contract-item-name]#++onlyRiskpoolService++#++()++` [.item-kind]#modifier#

[.contract-item]
[[PoolController-onlyTreasury--]]
==== `[.contract-item-name]#++onlyTreasury++#++()++` [.item-kind]#modifier#
[[PoolController-onlyActivePool-uint256-]]
==== `[.contract-item-name]#++onlyActivePool++#++(uint256 riskpoolId)++` [.item-kind]#modifier#

[.contract-item]
[[PoolController-onlyActivePoolForProcess-bytes32-]]
==== `[.contract-item-name]#++onlyActivePoolForProcess++#++(bytes32 processId)++` [.item-kind]#modifier#

[.contract-item]
[[PoolController-_afterInitialize--]]
Expand Down Expand Up @@ -1374,7 +1381,7 @@ import "@etherisc/gif-contracts/contracts/modules/PoolController.sol";

[.contract]
[[QueryModule]]
=== `++QueryModule++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/QueryModule.sol[{github-icon},role=heading-link]
=== `++QueryModule++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/QueryModule.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -1492,7 +1499,7 @@ import "@etherisc/gif-contracts/contracts/modules/QueryModule.sol";

[.contract]
[[RegistryController]]
=== `++RegistryController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/RegistryController.sol[{github-icon},role=heading-link]
=== `++RegistryController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/RegistryController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -1669,7 +1676,7 @@ Deregister contract in certain release

[.contract]
[[TreasuryModule]]
=== `++TreasuryModule++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/modules/TreasuryModule.sol[{github-icon},role=heading-link]
=== `++TreasuryModule++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/modules/TreasuryModule.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down
12 changes: 6 additions & 6 deletions docs/modules/api/pages/services.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ NOTE: This document is better viewed at https://docs.etherisc.com/contracts/api/

[.contract]
[[ComponentOwnerService]]
=== `++ComponentOwnerService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/services/ComponentOwnerService.sol[{github-icon},role=heading-link]
=== `++ComponentOwnerService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/services/ComponentOwnerService.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -273,7 +273,7 @@ import "@etherisc/gif-contracts/contracts/services/ComponentOwnerService.sol";

[.contract]
[[InstanceOperatorService]]
=== `++InstanceOperatorService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/services/InstanceOperatorService.sol[{github-icon},role=heading-link]
=== `++InstanceOperatorService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/services/InstanceOperatorService.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -536,7 +536,7 @@ import "@etherisc/gif-contracts/contracts/services/InstanceOperatorService.sol";

[.contract]
[[InstanceService]]
=== `++InstanceService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/services/InstanceService.sol[{github-icon},role=heading-link]
=== `++InstanceService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/services/InstanceService.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -868,7 +868,7 @@ import "@etherisc/gif-contracts/contracts/services/InstanceService.sol";

[.contract]
[[OracleService]]
=== `++OracleService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/services/OracleService.sol[{github-icon},role=heading-link]
=== `++OracleService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/services/OracleService.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -928,7 +928,7 @@ import "@etherisc/gif-contracts/contracts/services/OracleService.sol";

[.contract]
[[ProductService]]
=== `++ProductService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/services/ProductService.sol[{github-icon},role=heading-link]
=== `++ProductService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/services/ProductService.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -995,7 +995,7 @@ https://github.com/OpenZeppelin/openzeppelin-contracts/blob/release-v4.6/contrac

[.contract]
[[RiskpoolService]]
=== `++RiskpoolService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/services/RiskpoolService.sol[{github-icon},role=heading-link]
=== `++RiskpoolService++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/services/RiskpoolService.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down
8 changes: 4 additions & 4 deletions docs/modules/api/pages/shared.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ NOTE: This document is better viewed at https://docs.etherisc.com/contracts/api/

[.contract]
[[CoreController]]
=== `++CoreController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/shared/CoreController.sol[{github-icon},role=heading-link]
=== `++CoreController++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/shared/CoreController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -115,7 +115,7 @@ import "@etherisc/gif-contracts/contracts/shared/CoreController.sol";

[.contract]
[[CoreProxy]]
=== `++CoreProxy++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/shared/CoreProxy.sol[{github-icon},role=heading-link]
=== `++CoreProxy++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/shared/CoreProxy.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -208,7 +208,7 @@ import "@etherisc/gif-contracts/contracts/shared/CoreProxy.sol";

[.contract]
[[TransferHelper]]
=== `++TransferHelper++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/shared/TransferHelper.sol[{github-icon},role=heading-link]
=== `++TransferHelper++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/shared/TransferHelper.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down Expand Up @@ -259,7 +259,7 @@ import "@etherisc/gif-contracts/contracts/shared/TransferHelper.sol";

[.contract]
[[WithRegistry]]
=== `++WithRegistry++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0/contracts/shared/WithRegistry.sol[{github-icon},role=heading-link]
=== `++WithRegistry++` link:https://github.com/etherisc/gif-contracts/blob/release-v2.0.0-rc.1-0/contracts/shared/WithRegistry.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
Expand Down
Loading