Reorganize v4 Technical Reference (#765)

Uniswap · Sep 17, 2024 · 4522d97 · 4522d97
1 parent dd04160
commit 4522d97
Show file tree

Hide file tree

Showing 17 changed files with 12 additions and 20 deletions.
diff --git a/...ntracts/v4/reference/core/01-overview.mdx → 02-overview.mdx b/...ntracts/v4/reference/core/01-overview.mdx → 02-overview.mdx
diff --git a/docs/contracts/v4/concepts/07-dynamic-fees.mdx b/docs/contracts/v4/concepts/07-dynamic-fees.mdx
@@ -1,5 +1,5 @@
 ---
-title: Introduction to Dynamic Fees
+title: Dynamic Fees
 ---
 
 Uniswap v4 introduces dynamic fees, allowing for flexible and responsive fee structures managed through hooks. This feature enables pools to adapt fees to changing market conditions, potentially improving liquidity provider profitability and overall market efficiency.

diff --git a/docs/contracts/v4/guides/04-hooks/setup.mdx → ...contracts/v4/guides/04-hooks/00-setup.mdx b/docs/contracts/v4/guides/04-hooks/setup.mdx → ...contracts/v4/guides/04-hooks/00-setup.mdx
diff --git a/docs/contracts/v4/guides/08-testing.mdx b/docs/contracts/v4/guides/08-testing.mdx
diff --git a/docs/contracts/v4/reference/core/_category_.json b/docs/contracts/v4/reference/core/_category_.json
@@ -1,5 +1,5 @@
 {
   "label": "Core",
   "position": 1,
-  "collapsed": true
+  "collapsed": false
 }
diff --git a/...ts/v4/reference/core/LiquidityAmounts.mdx → ...ence/core/libraries/liquidity-amounts.mdx b/...ts/v4/reference/core/LiquidityAmounts.mdx → ...ence/core/libraries/liquidity-amounts.mdx
diff --git a/docs/contracts/v4/reference/core/libraries/state-library.mdx b/docs/contracts/v4/reference/core/libraries/state-library.mdx
@@ -1,5 +1,5 @@
 ---
-title: StateLibrary.sol
+title: StateLibrary
 ---
 
 (TODO: state library)
diff --git a/.../reference/core/TransientStateLibrary.mdx → ...ore/libraries/transient-state-library.mdx b/.../reference/core/TransientStateLibrary.mdx → ...ore/libraries/transient-state-library.mdx
@@ -1,5 +1,5 @@
 ---
-title: Transient State Library
+title: TransientStateLibrary
 ---
 
 The `TransientStateLibrary` is a crucial component of Uniswap V4, providing utility functions for managing transient state in the PoolManager contract. This library handles operations related to reserves, delta counts, and locking state, which are essential for the efficient and secure operation of the Uniswap V4 protocol.

diff --git a/docs/contracts/v4/reference/core/poolmanager.mdx b/docs/contracts/v4/reference/core/poolmanager.mdx
diff --git a/docs/contracts/v4/reference/core/types/_category_.json b/docs/contracts/v4/reference/core/types/_category_.json
@@ -0,0 +1,5 @@
+{
+  "label": "Types",
+  "position": 1,
+  "collapsed": true
+}
diff --git a/...tracts/v4/reference/core/BalanceDelta.mdx → .../v4/reference/core/types/balancedelta.mdx b/...tracts/v4/reference/core/BalanceDelta.mdx → .../v4/reference/core/types/balancedelta.mdx
diff --git a/...cts/v4/reference/core/BeforeSwapDelta.mdx → .../reference/core/types/beforeswapdelta.mdx b/...cts/v4/reference/core/BeforeSwapDelta.mdx → .../reference/core/types/beforeswapdelta.mdx
diff --git a/.../contracts/v4/reference/core/Currency.mdx → ...acts/v4/reference/core/types/currency.mdx b/.../contracts/v4/reference/core/Currency.mdx → ...acts/v4/reference/core/types/currency.mdx
diff --git a/docs/contracts/v4/reference/core/PoolKey.mdx → ...racts/v4/reference/core/types/poolkey.mdx b/docs/contracts/v4/reference/core/PoolKey.mdx → ...racts/v4/reference/core/types/poolkey.mdx
diff --git a/docs/contracts/v4/reference/periphery/_category_.json b/docs/contracts/v4/reference/periphery/_category_.json
@@ -1,5 +1,5 @@
 {
   "label": "Periphery",
   "position": 2,
-  "collapsed": false
+  "collapsed": true
 }
diff --git a/docs/contracts/v4/reference/periphery/overview.mdx b/docs/contracts/v4/reference/periphery/overview.mdx
diff --git a/docs/contracts/v4/reference/periphery/positionmanager.mdx b/docs/contracts/v4/reference/periphery/positionmanager.mdx
@@ -1,5 +1,5 @@
 ---
-title: PositionManager.sol
+title: PositionManager
 ---
 
-(TODO: posm)
+... in progress, please see [mint position](../../guides/02-manage-liquidity/01-mint-position.mdx)