diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 00000000..88b1e0bb --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,50 @@ +name: Deploy Documentation + +on: + push: + branches: + - development + - feat/doc +# paths: +# - 'pkg/seawater/**' + +#on: +# push: +# branches: +# - development +# pull_request: +# branches: +# - development + +jobs: + + deploy: +# if: github.event_name == 'push' && github.ref == 'refs/heads/development' + runs-on: ubuntu-latest + needs: build + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + with: + submodules: recursive + + - name: Setup Foundry toolchain + uses: foundry-rs/foundry-toolchain@v1 + + - name: Generate documentation + run: | + cd pkg + forge doc + + - name: Deploy to GitHub Pages + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: | + cd pkg/docs-out + git init + git config user.name 'github-actions[bot]' + git config user.email 'github-actions[bot]@users.noreply.github.com' + git add . + git commit -m 'Deploy documentation' + git push --force --quiet "https://${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git" HEAD:gh-pages diff --git a/.github/workflows/deploy-ingestor.yml b/.github/workflows/deploy-ingestor.yml deleted file mode 100644 index e69de29b..00000000 diff --git a/pkg/interfaces/ISeawaterEvents.sol b/pkg/interfaces/ISeawaterEvents.sol index 5bd6fcde..daa39455 100644 --- a/pkg/interfaces/ISeawaterEvents.sol +++ b/pkg/interfaces/ISeawaterEvents.sol @@ -20,7 +20,7 @@ interface ISeawaterEvents { /// @notice emitted when a position is burned /// @param id the id of the position being burned - //// @param owner the user the owned the position + /// @param owner the user the owned the position event BurnPosition( uint256 indexed id, address indexed owner @@ -29,7 +29,7 @@ interface ISeawaterEvents { /// @notice emitted when a position changes owners /// @param from the original owner of the position /// @param to the new owner of the position - /// @param id the id of the position being transfered + /// @param id the id of the position being transferred event TransferPosition( address indexed from, address indexed to, @@ -45,9 +45,9 @@ interface ISeawaterEvents { ); /// @notice emitted when a liquidity provider collects the fees associated with a position - /// @param id the id of the position who's liquidity is being collected + /// @param id the id of the position whose liquidity is being collected /// @param pool the address of the pool the position is associated with - /// @param to the receipient of the fees + /// @param to the recipient of the fees /// @param amount0 the amount of token0 being collected /// @param amount1 the amount of token1 being collected event CollectFees( @@ -63,7 +63,8 @@ interface ISeawaterEvents { /// @notice emitted when a new pool is created /// @param token the token0 the pool is associated with (where token1 is a fluid token) /// @param fee the fee being used for this pool - /// @param price the starting price for this pool + /// @param decimals the decimals for the token + /// @param tickSpacing the tick spacing for the pool event NewPool( address indexed token, uint32 indexed fee,