Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: first draft for the v4 sdk tech reference, overview tbd #858

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

0xdevant
Copy link
Contributor

@0xdevant 0xdevant commented Jan 17, 2025

First draft for the v4 SDK's Overview + Technical Reference

  • typescript docgen based on v4 sdk repo
  • I want to follow the format of v3 sdk docs as close as possible so I fixed some formatting issues e.g. extra title and texts, broken links in breadcrumbs, broken links to md for type-aliases etc
  • updated wordings and fixed links in Overview

TBD: type aliases, variables and functions could be moved back to Tech Reference Overview like what v3 sdk did

Copy link

vercel bot commented Jan 17, 2025

@0xdevant is attempting to deploy a commit to the Uniswap Team on Vercel.

A member of the Team first needs to authorize it.

@saucepoint
Copy link
Collaborator

can we add the script & submodule so its reproducible

i.e.

https://github.com/Uniswap/docs/blob/main/scripts/v4-forge-doc.sh

https://github.com/Uniswap/docs/tree/main/submodules

@seeyijie
Copy link
Contributor

seeyijie commented Jan 18, 2025

Added script to generate docs!

There are still some links that needs to be manually edited (fixed manually by @0xdevant) because the copy and paste may have messed things up. The docs are complete but every time the script needs to be run, just need to manually check which link needs to be updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants