Skip to content

[Docs] Missing cross-links and structural gaps in developers.uniswap.org #1130

@lau90eth

Description

@lau90eth

Summary

During a navigation audit of developers.uniswap.org/docs (May 2026), I found several structural issues that block developer onboarding.

Structural Gaps

  1. No inline API reference — API docs live on a separate domain (api-docs.uniswap.org) with no integrated search or navigation inside the main developer portal.
  2. Missing v3 → v4 migration guide — No comparative guide for devs migrating existing integrations.
  3. Hook guides lack production patterns — The Counter Hook example is too basic; intermediate patterns (dynamic fees, oracles, limit orders) and end-to-end deployment guides (address derivation, bit flags, CREATE2) are missing.
  4. No docs bug-reporting channel — The official feedback Google Form collects role/experience data but has no field to report broken links or documentation errors.

Suggested Fixes

  • Integrate API reference pages directly into developers.uniswap.org/docs/api/reference.
  • Add a [Docs Bug] issue template to this repo.
  • Provide a "Report a docs issue" link in the portal footer.

Environment

  • Date tested: 2026-05-06

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions