Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Thanks for giving a little extra love to the Uniswap docs! Below are some basic

The docs published at [developers.uniswap.org](https://developers.uniswap.org) are built from a separate source repository. When we accept a change here, we port it into that publishing pipeline, so your fix may go live on the site before it appears in this repository. Content here is updated in batches on a regular cadence, and accepted contributions are credited as commit co-authors. See the [README](README.md) for details.

All documentation lives in the `content/` directory, and that is where content changes belong. The `archive/` directory holds the previous version of this repository for reference only; PRs against it will not be accepted.

By submitting a pull request you agree that your contribution is licensed under this repository's [MIT license](LICENSE).

## Creating a pull request
Expand Down Expand Up @@ -38,3 +40,4 @@ git checkout -b "my-contribution"
- Every `.mdx` page needs `title` and `description` frontmatter (see the [README](README.md))
- Keep pages concise and cross-link related pages instead of repeating content
- Place images in the `images/` directory of the section that uses them
- All content lives under `content/`; do not add or edit files under `archive/`
57 changes: 22 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,48 +2,35 @@

Source content for the Uniswap developer documentation published at [developers.uniswap.org](https://developers.uniswap.org).

All documentation lives in the [`content/`](content) directory. Content changes (fixes, new pages, examples) belong there. The [`archive/`](archive) directory holds the previous version of this repository, kept for reference only.

## Repository structure

```
├── get-started/ # Core concepts and quickstart
│ └── concepts/ # AMMs, liquidity, swaps, fees, price impact
├── trading/ # Trading integrations
│ └── swapping-api/ # Swapping API guides and reference
├── liquidity/ # Liquidity integrations
│ ├── liquidity-launchpad/ # Token launch tooling
│ ├── liquidity-provisioning-api/ # Liquidity Provisioning API
│ └── uniswapx/ # UniswapX: quoting, filling, concepts
├── protocols/ # Protocol documentation
│ ├── v2/ v3/ v4/ # Core protocol versions, concepts, guides
│ ├── universal-router/ # Universal Router
│ ├── permit2/ # Permit2 approvals
│ ├── smart-wallet/ # Smart wallet
│ ├── the-compact/ # The Compact
│ └── protocol-fee/ # Protocol fee
├── sdks/ # SDK documentation
│ └── v2/ v3/ v4/ # Per-version SDK guides and reference
├── uniswap-ai/ # Uniswap AI skills and plugins
├── unichain/ # Unichain
│ ├── getting-started/ # Connect, bridge, deploy
│ ├── guides/ # Builder guides
│ ├── technical-information/ # Contracts, network details
│ └── tools/ # Ecosystem tooling
├── ecosystem/ # Ecosystem resources
│ ├── governance/ # Governance processes and reference
│ ├── subgraphs/ # Subgraph data and queries
│ └── builder-support/ # Support programs for builders
├── community/ # Community tooling and learning resources
├── changelog/ # API and protocol change notifications
├── examples/ # Example contracts and SDK snippets
│ ├── smart-contracts/ # Solidity examples
│ └── sdk/ # SDK examples
├── archive/ # Previous version of this repository, kept for reference
└── meta.json # Root navigation configuration
├── content/ # developers.uniswap.org content
│ ├── get-started/ # Core concepts and quickstart
│ ├── trading/ # Trading integrations, Swapping API
│ ├── liquidity/ # UniswapX, Liquidity Launchpad, Provisioning API
│ ├── protocols/ # v2, v3, v4, Universal Router, Permit2,
│ │ # smart wallet, The Compact, protocol fee
│ ├── sdks/ # SDK documentation (v2, v3, v4)
│ ├── uniswap-ai/ # Uniswap AI skills and plugins
│ ├── unichain/ # Unichain: getting started, guides, tooling
│ ├── ecosystem/ # Governance, subgraphs, builder support
│ ├── community/ # Community tooling and learning resources
│ ├── changelog/ # API and protocol change notifications
│ ├── examples/ # Example contracts and SDK snippets
│ └── meta.json # Root navigation configuration
├── archive/ # Previous version of this repository (reference only)
├── CONTRIBUTING.md
├── DISCLAIMER.md
├── LICENSE
└── README.md
```

## Contributing

Contributions are welcome, and our team reviews every PR. See the [contribution guidelines](CONTRIBUTING.md) for how the process works and how to get started.
Contributions are welcome, and our team reviews every PR. Content changes go inside `content/`. See the [contribution guidelines](CONTRIBUTING.md) for how the process works and how to get started.

## Content conventions

Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Loading