removed leading numbers from file and folder names and added sidebar … (#1026)

aravind33b · ocandocrypto · web-flow · commit 0c8b356604b8 · 2025-10-21T10:42:56.000+08:00
Co-authored-by: Angela O &lt;124130440+ocandocrypto@users.noreply.github.com&gt;
diff --git a/docs/ai-coding/overview.mdx b/docs/ai-coding/overview.mdx
@@ -0,0 +1,52 @@
+---
+title: Using LLMs.txt or LLMs-full.txt
+description: Uniswap docs are LLM-ready and help developers build on Uniswap v4 faster and more efficiently.
+---
+
+## Understanding Context Windows
+
+AI models have a context window, which is the amount of text they can process at once. This is typically the number of tokens that can be processed in a single request (more like it's memory capacity).
+Once the context window fills up, parts of your conversational history may be lost.
+
+It is exactly for this reason, providing relevant context upfront is critical.
+
+## llms.txt and llms-full.txt
+
+Depending on the model's context window, you can either use llms.txt or llms-full.txt. Most of the modern models have a [context window of about 100k tokens](https://codingscape.com/blog/llms-with-largest-context-windows).
+
+For most cases we are good to go with llms.txt as it is more compact and provides the LLM with necessary information about links from the documentation and what it does.
+
+If you are using a model with a larger context window, you can use llms-full.txt. It is a more verbose version of llms.txt and provides the LLM with more information about the documentation.
+
+## Using llms.txt or llms-full.txt file
+
+You can provide your code editor with a llms.txt or llms-full.txt file to use Unichain docs as a context for your code.
+
+Here's how to do it for some common code editors:
+
+#### Cursor
+1. Navigate to Cursor Settings > Features > Docs
+2. Select “Add new doc” and paste the following URL:
+```
+https://docs.uniswap.org/v4-llms.txt
+```
+or
+
+```
+https://docs.uniswap.org/v4-llms-full.txt
+```
+3. Use @docs -> Uniswap to reference Uniswap docs in your chat.
+
+#### Windsurf
+
+Windsurf doesn't have a permanent settings menu for adding documentation context, so you need to reference it in each conversation where you want to use it.
+1. You can directly add it to the Cascade window (CMD+L) using:
+```
+@docs:https://docs.uniswap.org/v4-llms.txt
+```
+or
+
+```
+@docs:https://docs.uniswap.org/v4-llms-full.txt
+```
+
diff --git a/docs/concepts/governance/adversarial-circumstances.md b/docs/concepts/governance/adversarial-circumstances.md
@@ -1,6 +1,7 @@
 ---
 id: adversarial-circumstances
 title: Adversarial Circumstances
+sidebar_position: 4
 ---
 
 This document explores some adversarial circumstances which Uniswap Governance may encounter in the future. Its goal is to help those interested in Uniswap Governance understand the reasoning behind some of its design, its limitations, and potential avenues for growth.
diff --git a/docs/concepts/governance/glossary.md b/docs/concepts/governance/glossary.md
@@ -1,6 +1,7 @@
 ---
 id: glossary
 title: Glossary
+sidebar_position: 5
 ---
 
 - **UNI:** An ERC-20 token that designates the weight of a user&#39;s voting rights. The more UNI a user has in their wallet, the more weight their delegation or vote on a proposal holds.
diff --git a/docs/concepts/governance/guide-to-voting.md b/docs/concepts/governance/guide-to-voting.md
@@ -1,6 +1,7 @@
 ---
 id: guide-to-voting
 title: Beginners' Guide to Voting
+sidebar_position: 3
 ---
 
 This guide contains everything you need to start voting in Uniswap Governance.
diff --git a/docs/concepts/governance/overview.md b/docs/concepts/governance/overview.md
@@ -1,6 +1,7 @@
 ---
 id: overview
 title: Overview
+sidebar_position: 1
 ---
 
 ## Code
diff --git a/docs/concepts/governance/process.md b/docs/concepts/governance/process.md
@@ -1,6 +1,7 @@
 ---
 id: process
 title: Process
+sidebar_position: 2
 ---
 
 This is a living document which represents the current process guidelines for developing and advancing Uniswap Governance Proposals. It was last updated September 2024.
diff --git a/docs/contracts/v4/concepts/PoolManager.mdx b/docs/contracts/v4/concepts/PoolManager.mdx
@@ -1,5 +1,6 @@
 ---
 title: PoolManager
+sidebar_position: 6
 ---
 
 In Uniswap v3, each liquidity pool was represented by a separate smart contract deployed through the Uniswapv3Factory contract. While this approach provided flexibility, it also led to increased gas costs for pool creation and multi-hop swaps.
diff --git a/docs/contracts/v4/concepts/dynamic-fees.mdx b/docs/contracts/v4/concepts/dynamic-fees.mdx
@@ -1,5 +1,6 @@
 ---
 title: Dynamic Fees
+sidebar_position: 7
 ---
 
 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/concepts/erc6909.mdx b/docs/contracts/v4/concepts/erc6909.mdx
@@ -1,5 +1,6 @@
 ---
 title: ERC-6909
+sidebar_position: 3
 ---
 
 Uniswap v4 uses [ERC-6909](https://eips.ethereum.org/EIPS/eip-6909) to further improve gas-efficiency on token claims and redemptions.
diff --git a/docs/contracts/v4/concepts/fee-structure.mdx b/docs/contracts/v4/concepts/fee-structure.mdx
@@ -1,4 +1,8 @@
-# v4 Fee Structure Guide
+---
+id: fee structure
+title: v4 Fee Structure Guide
+sidebar_position: 9
+---
 
 ## Overview of Fee Types
 
diff --git a/docs/contracts/v4/concepts/flash-accounting.mdx b/docs/contracts/v4/concepts/flash-accounting.mdx
@@ -1,5 +1,6 @@
 ---
 title: Flash Accounting
+sidebar_position: 2
 ---
 
 ## Flash Accounting
diff --git a/docs/contracts/v4/concepts/hooks.mdx b/docs/contracts/v4/concepts/hooks.mdx
@@ -1,5 +1,6 @@
 ---
 title: Hooks
+sidebar_position: 4
 ---
 
 Uniswap v4 introduces Hooks, a system that allows developers to customize and extend the behavior of liquidity pools.
diff --git a/docs/contracts/v4/concepts/integrated-routing-uniswap-x.mdx b/docs/contracts/v4/concepts/integrated-routing-uniswap-x.mdx
@@ -1,5 +1,6 @@
 ---
 title: Integrated Routing with UniswapX
+sidebar_position: 8
 ---
 
 The [Uniswap Interface](https://app.uniswap.org) will be ramping up support for hooks in its standard routing system progressively over time. Hook builders looking to get immediate access to flow from the interface can do so by running a UniswapX filler for their hooked pools. 
diff --git a/docs/contracts/v4/concepts/security.mdx b/docs/contracts/v4/concepts/security.mdx
diff --git a/docs/contracts/v4/concepts/subscribers.mdx b/docs/contracts/v4/concepts/subscribers.mdx
@@ -1,5 +1,6 @@
 ---
 title: Subscribers
+sidebar_position: 5
 ---
 
 Subscribers, new in Uniswap v4, allow for liquidity-position owners to opt-in to a contract that receives _notifications_.
diff --git a/docs/contracts/v4/concepts/v4-vs-v3.mdx b/docs/contracts/v4/concepts/v4-vs-v3.mdx
@@ -1,5 +1,6 @@
 ---
 title: v4 vs v3
+sidebar_position: 1
 ---
 
 While Uniswap v4's underlying concentrated liquidity is the same as Uniswap v3,
diff --git a/docs/contracts/v4/guides/ERC-6909.mdx b/docs/contracts/v4/guides/ERC-6909.mdx
@@ -1,5 +1,6 @@
 ---
 title: ERC-6909
+sidebar_position: 5
 ---
 
 ## Introduction
diff --git a/docs/contracts/v4/guides/accessing-msg.sender-using-hook.mdx b/docs/contracts/v4/guides/accessing-msg.sender-using-hook.mdx
@@ -1,5 +1,6 @@
 ---
 title: Access msg.sender Inside a Hook
+sidebar_position: 9
 ---
 
 In Uniswap v4, when a hook is triggered, `msg.sender` is always the PoolManager contract, not the EOA or smart-account that initiated the swap. This behavior occurs because the PoolManager acts as an intermediary, executing the swap logic on behalf of the user.
diff --git a/docs/contracts/v4/guides/custom-accounting.mdx b/docs/contracts/v4/guides/custom-accounting.mdx
@@ -1,5 +1,6 @@
 ---
 title: Custom Accounting
+sidebar_position: 3
 ---
 
 ## Introduction
diff --git a/docs/contracts/v4/guides/flash-accounting.mdx b/docs/contracts/v4/guides/flash-accounting.mdx
@@ -1,5 +1,6 @@
 ---
 title: Flash Accounting
+sidebar_position: 8
 ---
 
 ## Introduction
diff --git a/docs/contracts/v4/guides/hooks/hook-deployment.mdx b/docs/contracts/v4/guides/hooks/hook-deployment.mdx
@@ -1,10 +1,11 @@
 ---
 title: Hook Deployment
+sidebar_position: 2
 ---
 
 ## Hook Flags
 
-As mentioned in [Concept of Hooks](../../concepts/04-hooks.mdx), hook contracts indicate their implemented functions by __encoding its behavior in the address of the contract__. The `PoolManager` uses these permissions to determine which hook functions to call for a given pool. See `PoolManager` deployment addresses [here](/contracts/v4/deployments).
+As mentioned in [Concept of Hooks](../../concepts/hooks.mdx), hook contracts indicate their implemented functions by __encoding its behavior in the address of the contract__. The `PoolManager` uses these permissions to determine which hook functions to call for a given pool. See `PoolManager` deployment addresses [here](/contracts/v4/deployments).
 
 Each hook function e.g. `beforeSwap` - corresponds to a certain _flag_. For example, the `beforeSwap` function is correlated to the [`BEFORE_SWAP_FLAG`](https://github.com/Uniswap/v4-core/blob/main/src/libraries/Hooks.sol#L37) which has a value of `1 << 7`.
 
diff --git a/docs/contracts/v4/guides/hooks/your-first-hook.md b/docs/contracts/v4/guides/hooks/your-first-hook.md
@@ -1,5 +1,6 @@
 ---
 title: Building Your First Hook
+sidebar_position: 1
 ---
 
 ## Introduction
diff --git a/docs/contracts/v4/guides/position-manager.mdx b/docs/contracts/v4/guides/position-manager.mdx
@@ -1,5 +1,6 @@
 ---
 title: Position Manager
+sidebar_position: 6
 ---
 
 ## Introduction
diff --git a/docs/contracts/v4/guides/read-pool-state.mdx b/docs/contracts/v4/guides/read-pool-state.mdx
@@ -1,5 +1,6 @@
 ---
 title: Reading Pool State
+sidebar_position: 2
 ---
 
 ## Introduction
diff --git a/docs/contracts/v4/guides/state-view.mdx b/docs/contracts/v4/guides/state-view.mdx
@@ -1,5 +1,6 @@
 ---
 title: StateView
+sidebar_position: 7
 ---
 
 ## Introduction
diff --git a/docs/contracts/v4/guides/swap-routing.mdx b/docs/contracts/v4/guides/swap-routing.mdx
@@ -1,5 +1,6 @@
 ---
 title: Swap routing
+sidebar_position: 4
 ---
 
 ## Introduction to Universal Router for Uniswap v4 Swaps
diff --git a/docs/contracts/v4/guides/unlock-callback.mdx b/docs/contracts/v4/guides/unlock-callback.mdx
@@ -1,5 +1,6 @@
 ---
 title: Unlock Callback & Deltas
+sidebar_position: 1
 ---
 
 ### Refresher
diff --git a/docs/contracts/v4/quickstart/02-manage-liquidity/_category_.json b/docs/contracts/v4/quickstart/02-manage-liquidity/_category_.json
diff --git a/docs/contracts/v4/quickstart/04-hooks/_category_.json b/docs/contracts/v4/quickstart/04-hooks/_category_.json
diff --git a/docs/contracts/v4/quickstart/create-pool.mdx b/docs/contracts/v4/quickstart/create-pool.mdx
@@ -1,5 +1,6 @@
 ---
 title: Create Pool
+sidebar_position: 1
 ---
 
 ## Context
diff --git a/docs/contracts/v4/quickstart/hooks/_category_.json b/docs/contracts/v4/quickstart/hooks/_category_.json
@@ -0,0 +1,5 @@
+{
+  "label": "Hooks",
+  "collapsed": true,
+  "position": 4
+}
diff --git a/docs/contracts/v4/quickstart/hooks/async-swap.mdx b/docs/contracts/v4/quickstart/hooks/async-swap.mdx
@@ -1,5 +1,6 @@
 ---
 title: AsyncSwap Hooks
+sidebar_position: 3
 ---
 
 One feature enabled by [custom accounting](/contracts/v4/guides/custom-accounting) is​​​​‌ AsyncSwap swap. This feature allows hook developers to replace the v4 (v3-style) swap logic.
diff --git a/docs/contracts/v4/quickstart/hooks/liquidity.mdx b/docs/contracts/v4/quickstart/hooks/liquidity.mdx
@@ -1,5 +1,6 @@
 ---
 title: Liquidity Hooks
+sidebar_position: 2
 ---
 
 This guide will walk through on an example of adding and removing liquidity. There are four hook functions available to customize and extend these behavior:
diff --git a/docs/contracts/v4/quickstart/hooks/setup.mdx b/docs/contracts/v4/quickstart/hooks/setup.mdx
@@ -1,5 +1,6 @@
 ---
 title:  Set Up Local Environment
+sidebar_position: 0
 ---
 
 Before writing the hook let's first have a local environment properly configured e.g. deploying pool manager, utility routers and test tokens. 
diff --git a/docs/contracts/v4/quickstart/hooks/swap.mdx b/docs/contracts/v4/quickstart/hooks/swap.mdx
@@ -1,5 +1,6 @@
 ---
 title: Swap Hooks
+sidebar_position: 1
 ---
 
 Swaps are the most common interaction with the Uniswap protocol. When it comes to swap there are two hook functions available to customize and extend its behavior:
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/_category_.json b/docs/contracts/v4/quickstart/manage-liquidity/_category_.json
@@ -0,0 +1,5 @@
+{
+  "label": "Manage Liquidity",
+  "collapsed": true,
+  "position": 2
+}
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/batch-liquidity.mdx b/docs/contracts/v4/quickstart/manage-liquidity/batch-liquidity.mdx
@@ -1,5 +1,6 @@
 ---
 title: Batch Modify
+sidebar_position: 6
 ---
 
 ### Context
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/burn-liquidity.mdx b/docs/contracts/v4/quickstart/manage-liquidity/burn-liquidity.mdx
@@ -1,5 +1,6 @@
 ---
 title: Burn Position
+sidebar_position: 5
 ---
 
 ### Context
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/collect.mdx b/docs/contracts/v4/quickstart/manage-liquidity/collect.mdx
@@ -1,10 +1,11 @@
 ---
 title: Collect Fees
+sidebar_position: 4
 ---
 
 ### Setup
 
-See the [setup guide](./00-setup-liquidity.mdx)
+See the [setup guide](./setup-liquidity.mdx)
 
 ## Guide
 
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/decrease-liquidity.mdx b/docs/contracts/v4/quickstart/manage-liquidity/decrease-liquidity.mdx
@@ -1,5 +1,6 @@
 ---
 title: Decrease Liquidity
+sidebar_position: 3
 ---
 
 ### Context
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/increase-liquidity.mdx b/docs/contracts/v4/quickstart/manage-liquidity/increase-liquidity.mdx
@@ -1,5 +1,6 @@
 ---
 title: Increase Liquidity
+sidebar_position: 2
 ---
 
 ### Context
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/mint-position.mdx b/docs/contracts/v4/quickstart/manage-liquidity/mint-position.mdx
@@ -1,5 +1,6 @@
 ---
 title: Mint Position
+sidebar_position: 1
 ---
 
 Similar to Uniswap v3, liquidity positions are minted as ERC-721 tokens and depend on a *periphery* contract.
diff --git a/docs/contracts/v4/quickstart/manage-liquidity/setup-liquidity.mdx b/docs/contracts/v4/quickstart/manage-liquidity/setup-liquidity.mdx
@@ -1,5 +1,6 @@
 ---
 title: Setup
+sidebar_position: 0
 ---
 
 For users looking to interact with the canonical Uniswap v4 `PositionManager`, _v4-periphery_ is a required dependency
diff --git a/docs/contracts/v4/quickstart/subscriber.mdx b/docs/contracts/v4/quickstart/subscriber.mdx
@@ -1,5 +1,6 @@
 ---
 title: Subscriber
+sidebar_position: 5
 ---
 
 ### Context
diff --git a/docs/contracts/v4/quickstart/swap.mdx b/docs/contracts/v4/quickstart/swap.mdx
@@ -1,5 +1,6 @@
 ---
 title: Swap
+sidebar_position: 3
 ---
 
 ## Swapping on Uniswap v4
diff --git a/docs/sdk/v4/guides/advanced/create-pool.md b/docs/sdk/v4/guides/advanced/create-pool.md
@@ -1,6 +1,7 @@
 ---
 id: create-pool
 title: Create Pool
+sidebar_position: 2
 ---
 
 ## Introduction
diff --git a/docs/sdk/v4/guides/advanced/pool-data.md b/docs/sdk/v4/guides/advanced/pool-data.md
@@ -1,6 +1,7 @@
 ---
 id: pool-data
 title: Fetching Pool Data
+sidebar_position: 1
 ---
 
 ## Introduction
diff --git a/docs/sdk/v4/guides/liquidity/add-remove-liquidity.md b/docs/sdk/v4/guides/liquidity/add-remove-liquidity.md
@@ -1,6 +1,7 @@
 ---
 id: add-remove-liquidity
 title: Adding and Removing Liquidity
+sidebar_position: 4
 ---
 
 ## Introduction
diff --git a/docs/sdk/v4/guides/liquidity/collecting-fees.md b/docs/sdk/v4/guides/liquidity/collecting-fees.md
@@ -1,6 +1,7 @@
 ---
 id: collect-fees
 title: Collecting Fee
+sidebar_position: 3
 ---
 
 ## Introduction
diff --git a/docs/sdk/v4/guides/liquidity/fetching-positions.md b/docs/sdk/v4/guides/liquidity/fetching-positions.md
diff --git a/docs/sdk/v4/guides/liquidity/minting-position.md b/docs/sdk/v4/guides/liquidity/minting-position.md
diff --git a/docs/sdk/v4/guides/swaps/multi-hop-swapping.md b/docs/sdk/v4/guides/swaps/multi-hop-swapping.md
diff --git a/docs/sdk/v4/guides/swaps/quoting.md b/docs/sdk/v4/guides/swaps/quoting.md
diff --git a/docs/sdk/v4/guides/swaps/single-hop-swapping.md b/docs/sdk/v4/guides/swaps/single-hop-swapping.md
diff --git a/docs/sdk/web3-react/guides/connect-wallet.md b/docs/sdk/web3-react/guides/connect-wallet.md
diff --git a/docs/sdk/web3-react/guides/connectors.md b/docs/sdk/web3-react/guides/connectors.md
diff --git a/docs/sdk/web3-react/guides/switch-chains.md b/docs/sdk/web3-react/guides/switch-chains.md
diff --git a/docs/universal-router-legacy/overview.md b/docs/universal-router-legacy/overview.md
diff --git a/docs/universal-router-legacy/technical-reference.md b/docs/universal-router-legacy/technical-reference.md
diff --git a/docusaurus.config.ts b/docusaurus.config.ts
diff --git a/package.json b/package.json
