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.

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

feat: deploy core documentation #2

Merged
merged 1 commit into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions build-docs.sh
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
#!/bin/bash

root_path="solidity/interfaces"
core_path="node_modules/@defi-wonderland/prophet-core-contracts"

# generate docs in a temporary directory
temp_folder="technical-docs"

mkdir ./solidity/contracts/core
mkdir ./solidity/interfaces/core
cp -r $core_path/solidity/contracts/* ./solidity/contracts/core
cp -r $core_path/solidity/interfaces/* ./solidity/interfaces/core

FOUNDRY_PROFILE=docs forge doc --out "$temp_folder"

rm -rf ./solidity/contracts/core
rm -rf ./solidity/interfaces/core

# edit generated summary not to have container pages
# - [jobs](solidity/interfaces/jobs/README.md)
# should become
Expand Down
23 changes: 16 additions & 7 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,22 @@
# Technical Documentation

- [Interfaces]()
- [❱ core](solidity/interfaces/core/README.md)
- [❱ external](solidity/interfaces/core/external/README.md)
- [IWETH9](solidity/interfaces/core/external/IWETH9.sol/interface.IWETH9.md)
- [❱ modules](solidity/interfaces/core/modules/README.md)
- [❱ dispute](solidity/interfaces/core/modules/dispute/README.md)
- [IDisputeModule](solidity/interfaces/core/modules/dispute/IDisputeModule.sol/interface.IDisputeModule.md)
- [❱ finality](solidity/interfaces/core/modules/finality/README.md)
- [IFinalityModule](solidity/interfaces/core/modules/finality/IFinalityModule.sol/interface.IFinalityModule.md)
- [❱ request](solidity/interfaces/core/modules/request/README.md)
- [IRequestModule](solidity/interfaces/core/modules/request/IRequestModule.sol/interface.IRequestModule.md)
- [❱ resolution](solidity/interfaces/core/modules/resolution/README.md)
- [IResolutionModule](solidity/interfaces/core/modules/resolution/IResolutionModule.sol/interface.IResolutionModule.md)
- [❱ response](solidity/interfaces/core/modules/response/README.md)
- [IResponseModule](solidity/interfaces/core/modules/response/IResponseModule.sol/interface.IResponseModule.md)
- [IModule](solidity/interfaces/core/IModule.sol/interface.IModule.md)
- [IOracle](solidity/interfaces/core/IOracle.sol/interface.IOracle.md)
- [❱ extensions](solidity/interfaces/extensions/README.md)
- [IAccountingExtension](solidity/interfaces/extensions/IAccountingExtension.sol/interface.IAccountingExtension.md)
- [IBondEscalationAccounting](solidity/interfaces/extensions/IBondEscalationAccounting.sol/interface.IBondEscalationAccounting.md)
Expand All @@ -65,28 +81,21 @@
- [IBondEscalationModule](solidity/interfaces/modules/dispute/IBondEscalationModule.sol/interface.IBondEscalationModule.md)
- [IBondedDisputeModule](solidity/interfaces/modules/dispute/IBondedDisputeModule.sol/interface.IBondedDisputeModule.md)
- [ICircuitResolverModule](solidity/interfaces/modules/dispute/ICircuitResolverModule.sol/interface.ICircuitResolverModule.md)
- [IDisputeModule](solidity/interfaces/modules/dispute/IDisputeModule.sol/interface.IDisputeModule.md)
- [IRootVerificationModule](solidity/interfaces/modules/dispute/IRootVerificationModule.sol/interface.IRootVerificationModule.md)
- [❱ finality](solidity/interfaces/modules/finality/README.md)
- [ICallbackModule](solidity/interfaces/modules/finality/ICallbackModule.sol/interface.ICallbackModule.md)
- [IFinalityModule](solidity/interfaces/modules/finality/IFinalityModule.sol/interface.IFinalityModule.md)
- [IMultipleCallbacksModule](solidity/interfaces/modules/finality/IMultipleCallbacksModule.sol/interface.IMultipleCallbacksModule.md)
- [❱ request](solidity/interfaces/modules/request/README.md)
- [IContractCallRequestModule](solidity/interfaces/modules/request/IContractCallRequestModule.sol/interface.IContractCallRequestModule.md)
- [IHttpRequestModule](solidity/interfaces/modules/request/IHttpRequestModule.sol/interface.IHttpRequestModule.md)
- [IRequestModule](solidity/interfaces/modules/request/IRequestModule.sol/interface.IRequestModule.md)
- [ISparseMerkleTreeRequestModule](solidity/interfaces/modules/request/ISparseMerkleTreeRequestModule.sol/interface.ISparseMerkleTreeRequestModule.md)
- [❱ resolution](solidity/interfaces/modules/resolution/README.md)
- [IArbitratorModule](solidity/interfaces/modules/resolution/IArbitratorModule.sol/interface.IArbitratorModule.md)
- [IBondEscalationResolutionModule](solidity/interfaces/modules/resolution/IBondEscalationResolutionModule.sol/interface.IBondEscalationResolutionModule.md)
- [IERC20ResolutionModule](solidity/interfaces/modules/resolution/IERC20ResolutionModule.sol/interface.IERC20ResolutionModule.md)
- [IPrivateERC20ResolutionModule](solidity/interfaces/modules/resolution/IPrivateERC20ResolutionModule.sol/interface.IPrivateERC20ResolutionModule.md)
- [IResolutionModule](solidity/interfaces/modules/resolution/IResolutionModule.sol/interface.IResolutionModule.md)
- [ISequentialResolutionModule](solidity/interfaces/modules/resolution/ISequentialResolutionModule.sol/interface.ISequentialResolutionModule.md)
- [❱ response](solidity/interfaces/modules/response/README.md)
- [IBondedResponseModule](solidity/interfaces/modules/response/IBondedResponseModule.sol/interface.IBondedResponseModule.md)
- [IResponseModule](solidity/interfaces/modules/response/IResponseModule.sol/interface.IResponseModule.md)
- [IArbitrator](solidity/interfaces/IArbitrator.sol/interface.IArbitrator.md)
- [IModule](solidity/interfaces/IModule.sol/interface.IModule.md)
- [IOracle](solidity/interfaces/IOracle.sol/interface.IOracle.md)
- [ITreeVerifier](solidity/interfaces/ITreeVerifier.sol/interface.ITreeVerifier.md)
Loading
Loading