fix: Add docs for Smart Contracts #96
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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 |
nakul1010
changed the title
nud3l
reviewed
Dec 12, 2023
…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
nud3l
approved these changes
Dec 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Steps
forge doc --out docs/docs/contractspython3 docs_reformat_scripts/forge_doc_reformat.pyNote: