Skip to content

Commit

Permalink
fix: remove overview from Core SDK (#508)
Browse files Browse the repository at this point in the history
  • Loading branch information
dannythedawger authored Nov 30, 2022
1 parent 43e95cb commit 5f0774d
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 10 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,9 +98,11 @@ Run `npx solidity-docgen --solc-module solc-0.7 -t ./templates`
Depending on how your project was created, you might have to install Typescript:
`npm install --save-dev typescript`

`typedoc --out <docs> src/index.ts`
`npx typedoc --out <docs> src/index.ts`

see https://www.npmjs.com/package/typedoc-plugin-markdown for details
You might have to use the `----skipErrorChecking` flag to the `typedoc` command for cases where types are fetched during transpile time, such as contract ABIs.

See https://www.npmjs.com/package/typedoc-plugin-markdown for details.

# How to Update search indices with algolia

Expand Down
2 changes: 1 addition & 1 deletion docs/api/subgraph/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Subgraph",
"position": 2,
"collapsed": true
"collapsed": false
}
2 changes: 1 addition & 1 deletion docs/api/subgraph/guides/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Guides",
"position": 2,
"collapsed": true
"collapsed": false
}
2 changes: 1 addition & 1 deletion docs/contracts/v3/reference/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Technical Reference",
"position": 4,
"collapsed": false
"collapsed": true
}
2 changes: 1 addition & 1 deletion docs/sdk/core/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "Core SDK",
"position": 2,
"position": 3,
"collapsed": true
}
3 changes: 1 addition & 2 deletions docs/sdk/core/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
id: overview
sidebar_position: 1
title: Overview
------

---
# The Uniswap Core SDK

> **Welcome to the V3 Core SDK!**
Expand Down
2 changes: 1 addition & 1 deletion docs/sdk/v2/_category_.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"label": "V2 SDK",
"position": 3,
"position": 4,
"collapsed": true
}
1 change: 0 additions & 1 deletion docs/sdk/v3/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ id: overview
sidebar_position: 1
title: Overview
---

# The Uniswap V3 SDK

> **Welcome to the V3 Uniswap SDK!**
Expand Down

1 comment on commit 5f0774d

@vercel
Copy link

@vercel vercel bot commented on 5f0774d Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

docs – ./

docs-git-main-uniswap.vercel.app
docs-uniswap.vercel.app
docs.uniswap.org

Please sign in to comment.