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 improvements #19

Open
flanagansteve opened this issue Sep 10, 2024 · 0 comments
Open

Docs improvements #19

flanagansteve opened this issue Sep 10, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation housekeeping Non-functional aesthetic changes low priority Low priority task to work on quickfix Issues that should be quickly resolvable

Comments

@flanagansteve
Copy link
Collaborator

flanagansteve commented Sep 10, 2024

  • In the swagger docs, reword the description here:
name: 'options'
description: 'Options DEX endpoints'

to "Options endpoints"

  • Rename subgraphURL / subgraphAPIURL in the config to panopticSubgraphUrl, or some other name that reflects that it has data about the Panoptic protocol and Uniswap
  • In the swagger docs:
    • Reword the /addLeg description - "summary: 'Create a position leg on tokenId'" - to "summary: 'Add a leg to a position (including initialising a position with its first leg)"
    • Update descriptions of any methods such as getCollateralToken0 to note that it will call the method on the supplied panoptic pool - currently they just say things like "gets collateral token0" which only makes sense if you have a hard-coded PanopticPool (which will change)
@ndeporzio ndeporzio added documentation Improvements or additions to documentation low priority Low priority task to work on housekeeping Non-functional aesthetic changes quickfix Issues that should be quickly resolvable labels Sep 10, 2024
@ndeporzio ndeporzio self-assigned this Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation housekeeping Non-functional aesthetic changes low priority Low priority task to work on quickfix Issues that should be quickly resolvable
Projects
None yet
Development

No branches or pull requests

2 participants