Skip to content

Redesign docs site #1022

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

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

Redesign docs site #1022

wants to merge 29 commits into from

Conversation

smblee
Copy link
Contributor

@smblee smblee commented Jul 24, 2025

Remaining items

  • mobile menu on home page (currently empty)
  • audit all contents are rendering properly
73818 image CleanShot 2025-07-24 at 17 31 32@2x image image

smblee and others added 26 commits December 4, 2024 02:55
* prettier and coderabbit

* pr template
* feat: add navigation

* feat: add footer

* fix: update types

* fix: attempt to fix font issue

* fix: lint

* fix: font

* fix: coderabbit comments

* fix: add button hover state

* fix: remove padding
* feat: add navigation

* feat: add footer

* fix: update types

* fix: attempt to fix font issue

* fix: coderabbit comments

* styling breadcrumbs and toc

* stylize breadcrumb sidenav prev next links and rebase

* add sentiment track block

* add icons

* rebase

* suppress prop type for swizzled files

* add aria label and remove unnecessary files

* refactor and add gif to prettier ignore

* remove unnecessary swizzled files

* fix preview

* remove files

* remove files

* add wrapper to toc

---------

Co-authored-by: Sohee Lim <[email protected]>
* feat: add home UI

* feat: add 404

* fix: style

* fix: typo
* qa for home UI and markdonw text

* preview fix

* fix theme switcher
…niswap#33)

* Update search workflow to trigger on push to this branch and add a step to install homebrew

* Use homebrew action to set up homebrew

* Use newer checkout action, refactor to use native package manager instead of homebrew

* Fix syntax error

* Use homebrew again

* Update docs for clarity

* Remove push event to trigger crawler
…s_v3' into bryan-01-14-redesign

* smblee/bryan-12-04-upgrade_to_docusaurus_v3: (22 commits)
  update v4 docs to be compliant with v3 styling, update margin
  docs: add Soneium and Ink v4 deployments (Uniswap#876)
  docs: update home index links for v4 (Uniswap#874)
  docs: update protocol intro with v4 references (Uniswap#872)
  docs: clean up unused imports and update v4 whitepaper link (Uniswap#868)
  docs: update READ.ME with v4 references (Uniswap#871)
  docs: update homepage guides for v4 (Uniswap#870)
  docs: add v4 updates to Uniswap Protocol Overview and Hooks to Protocol Concepts (Uniswap#869)
  docs: first draft for the v4 sdk tech reference, overview tbd (Uniswap#858)
  docs: update avalanche explorer (Uniswap#866)
  Update gas-optimization.md (Uniswap#860)
  docs: add all mainnet deployments for v4 (Uniswap#864)
  Update 05-range-orders.md (Uniswap#861)
  Update Celo-Deployments.md (Uniswap#862)
  v4 docs: UI enhancements, broken links, lowercase letters fixes and content updates (Uniswap#854)
  Fix Guide on Minting Position (Uniswap#859)
  Update 01-overview.md (Uniswap#852)
  docs: v4 hooks guides optimizations (Uniswap#844)
  StateView & Flash Accounting guides added (Uniswap#848)
  Update `decrease-liquidity.md` to fix a bug in the demo code (Uniswap#856)
  ...
…cusaurus_v3

* og/main: (90 commits)
  Add v4 security documentation with SEAL 911 emergency hotline (Uniswap#1019)
  Fix path error on remappings (Uniswap#1001)
  Update 03-swap.mdx (Uniswap#1002)
  You are wraping "key.currency1" into an ERC20 , but it is already a E… (Uniswap#1003)
  fix: typos in docs/contracts/v1/guides/04-custom-linking.md (Uniswap#1004)
  Fix broken background link in pool data guide (Uniswap#1007)
  fix: Update deployments.mdx for Arbitrum sepolia (Uniswap#1008)
  Update deployments.mdx (Uniswap#1009)
  Update AVAX-Deployments.md (Uniswap#1010)
  docs/v3/guides: Update examples repo link (Uniswap#1011)
  replace dead references (Uniswap#1013)
  v4 sdk overview doc (Uniswap#1005)
  fix: yarn build subgraph redirect (Uniswap#1012)
  docs: v4-sdk: minting/fetching/adding/removing position and collecting fee example (Uniswap#992)
  Added advanced guide: fetch pool data & pool creation (Uniswap#997)
  Add v4-subgraph-example guide. Rename and format subgraph-example. Update external links to thegraph explorer and v3-subgraph GitHub (Uniswap#965)
  docs: add v4 quoting & swapping guides (Uniswap#977)
  Docs: handling liquidity amount discrepancies (Uniswap#952)
  doc on the types of fees (Uniswap#1000)
  fix spelling issues  (Uniswap#998)
  ...
…redesign

* bryan-12-04-upgrade_to_docusaurus_v3: (99 commits)
  Add v4 security documentation with SEAL 911 emergency hotline (Uniswap#1019)
  Fix path error on remappings (Uniswap#1001)
  Update 03-swap.mdx (Uniswap#1002)
  You are wraping "key.currency1" into an ERC20 , but it is already a E… (Uniswap#1003)
  fix: typos in docs/contracts/v1/guides/04-custom-linking.md (Uniswap#1004)
  Fix broken background link in pool data guide (Uniswap#1007)
  fix: Update deployments.mdx for Arbitrum sepolia (Uniswap#1008)
  Update deployments.mdx (Uniswap#1009)
  Update AVAX-Deployments.md (Uniswap#1010)
  docs/v3/guides: Update examples repo link (Uniswap#1011)
  replace dead references (Uniswap#1013)
  v4 sdk overview doc (Uniswap#1005)
  fix: yarn build subgraph redirect (Uniswap#1012)
  docs: v4-sdk: minting/fetching/adding/removing position and collecting fee example (Uniswap#992)
  Added advanced guide: fetch pool data & pool creation (Uniswap#997)
  Add v4-subgraph-example guide. Rename and format subgraph-example. Update external links to thegraph explorer and v3-subgraph GitHub (Uniswap#965)
  docs: add v4 quoting & swapping guides (Uniswap#977)
  Docs: handling liquidity amount discrepancies (Uniswap#952)
  doc on the types of fees (Uniswap#1000)
  fix spelling issues  (Uniswap#998)
  ...
…redesign

* bryan-12-04-upgrade_to_docusaurus_v3:
  change Ins to note
Copy link

vercel bot commented Jul 24, 2025

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

A member of the Team first needs to authorize it.

Copy link

socket-security bot commented Jul 24, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updatednode-releases@​2.0.18 ⏵ 2.0.191001004177100
Updated@​algolia/​requester-browser-xhr@​5.15.0 ⏵ 5.20.010010048 +198100
Updatediterator.prototype@​1.1.3 ⏵ 1.1.5661007553100
Updatedarray-buffer-byte-length@​1.0.1 ⏵ 1.0.26710076 -151100
Updatedes-define-property@​1.0.0 ⏵ 1.0.167 +11008151100
Updatedtyped-array-buffer@​1.0.2 ⏵ 1.0.36610077 -151100
Updatedunbox-primitive@​1.0.2 ⏵ 1.1.06610081 +151100
Updatedget-symbol-description@​1.0.2 ⏵ 1.1.06710079 +151100
Updatedis-date-object@​1.0.5 ⏵ 1.1.06710081 +151100
Updatedsafe-regex-test@​1.0.3 ⏵ 1.1.06710079 +251100
Updatedarraybuffer.prototype.slice@​1.0.3 ⏵ 1.0.466 +11008751100
Updatedis-shared-array-buffer@​1.0.3 ⏵ 1.0.4671008351100
Updatedarray.prototype.flat@​1.3.2 ⏵ 1.3.3671009152100
Updatedsafe-array-concat@​1.1.2 ⏵ 1.1.36610083 +152100
Updatedside-channel@​1.0.6 ⏵ 1.1.06610086 +2152100
Updatedis-weakset@​2.0.3 ⏵ 2.0.4671008252100
Updatedinternal-slot@​1.0.7 ⏵ 1.1.06710086 +152100
Updatedarray.prototype.flatmap@​1.3.2 ⏵ 1.3.367 +110094 +152100
Updatedstring.prototype.trim@​1.2.9 ⏵ 1.2.106610081 +152100
Updatedis-generator-function@​1.0.10 ⏵ 1.1.06610078 +152100
Updatedstring.prototype.matchall@​4.0.11 ⏵ 4.0.12661009252100
Updatedtyped-array-byte-length@​1.0.1 ⏵ 1.0.3661009052100
Updatedis-weakref@​1.0.2 ⏵ 1.1.06710081 +252100
Updatedwhich-boxed-primitive@​1.1.0 ⏵ 1.1.1661009052100
Updatedtyped-array-byte-offset@​1.0.3 ⏵ 1.0.4661009052100
Updatedhas-proto@​1.1.0 ⏵ 1.2.067 +11008552100
Updatedis-symbol@​1.1.0 ⏵ 1.1.167 +11008052100
Updatedfunction.prototype.name@​1.1.6 ⏵ 1.1.8661008552100
Updatedis-number-object@​1.1.0 ⏵ 1.1.167 +11008352100
Updatedregexp.prototype.flags@​1.5.3 ⏵ 1.5.4661008552100
Updatedis-regex@​1.2.0 ⏵ 1.2.167 +11008352100
Updatedobject.assign@​4.1.5 ⏵ 4.1.767100100 +152100
Updatedfor-each@​0.3.3 ⏵ 0.3.467 +110078 -154100
See 231 more rows in the dashboard

View full report

Copy link

socket-security bot commented Jul 24, 2025

Warning

Review the following alerts detected in dependencies.

According to your organization's Security Policy, it is recommended to resolve "Warn" alerts. Learn more about Socket for GitHub.

Action Severity Alert  (click "▶" to expand/collapse)
Warn Medium
[email protected] has Shell access.

Module: child_process

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is shell access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Medium
[email protected] has Shell access.

Module: child_process

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is shell access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Medium
[email protected] has Shell access.

Module: child_process

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is shell access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: package.jsonnpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has a Dynamic require.

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is dynamic require?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: Packages should avoid dynamic imports when possible. Audit the use of dynamic require to ensure it is not executing malicious or vulnerable code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: yarn.locknpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has Filesystem access.

Module: fs

Location: Package overview

From: package.jsonnpm/[email protected]

ℹ Read more on: This package | This alert | What is filesystem access?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

Warn Low
[email protected] has a Dynamic require.

Location: Package overview

From: package.jsonnpm/[email protected]

ℹ Read more on: This package | This alert | What is dynamic require?

Next steps: Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at [email protected].

Suggestion: Packages should avoid dynamic imports when possible. Audit the use of dynamic require to ensure it is not executing malicious or vulnerable code.

Mark the package as acceptable risk. To ignore this alert only in this pull request, reply with the comment @SocketSecurity ignore npm/[email protected]. You can also ignore all packages with @SocketSecurity ignore-all. To ignore an alert for all future pull requests, use Socket's Dashboard to change the triage state of this alert.

View full report

@smblee smblee marked this pull request as ready for review August 5, 2025 19:23
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.

4 participants