-
Notifications
You must be signed in to change notification settings - Fork 45
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
fix: Add docs for Smart Contracts #96
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
…akul/feat_contract_docs
…akul/feat_contract_docs
@nud3l & @gregdhill need to push generated Ideally need to design and maintain foundry- docusaurus plugin similar to what hardhat has here |
…akul/feat_contract_docs # Conflicts: # docs/docs/contracts/src/src/bridge/BitcoinTx.sol/library.BitcoinTx.md # docs/docs/contracts/src/src/bridge/BridgeState.sol/library.BridgeState.md # docs/docs/contracts/src/src/bridge/IRelay.sol/interface.IRelay.md # docs/docs/contracts/src/src/bridge/WitnessTx.sol/library.WitnessTx.md # docs/docs/contracts/src/src/faucet/Erc20Minter.sol/contract.Erc20Minter.md # docs/docs/contracts/src/src/faucet/Erc20Minter.sol/interface.Erc20Mintable.md # docs/docs/contracts/src/src/relay/LightRelay.sol/contract.LightRelay.md # docs/docs/contracts/src/src/relay/LightRelay.sol/interface.ILightRelay.md # docs/docs/contracts/src/src/relay/LightRelay.sol/library.RelayUtils.md # docs/docs/contracts/src/src/relay/LightRelay.sol/struct.Epoch.md # docs/docs/contracts/src/src/relay/TestLightRelay.sol/contract.TestLightRelay.md # docs/docs/contracts/src/src/swap/Bridge.sol/contract.Bridge.md # docs/docs/contracts/src/src/swap/Btc_Marketplace.sol/contract.BtcMarketPlace.md # docs/docs/contracts/src/src/swap/Marketplace.sol/contract.MarketPlace.md # docs/docs/contracts/src/src/swap/Wrapped.sol/contract.BobWrappedBtc.md
Steps
forge doc --out docs/docs/contracts
python3 docs_reformat_scripts/forge_doc_reformat.py
Note: