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

Please make the documentation more clear #451

Open
0xHans1 opened this issue Jul 24, 2023 · 0 comments
Open

Please make the documentation more clear #451

0xHans1 opened this issue Jul 24, 2023 · 0 comments

Comments

@0xHans1
Copy link

0xHans1 commented Jul 24, 2023

Hi Paraswap Team,

can you improve the documention. Things that i stumpled accross and would make the devs live easier:

  • high level archicture how the lib is basically working and what functions from a dex integration are called
  • Better code documentation. There some basic comments on the test files, but for example there could be more documentation in the template files where devs need to complete the code
  • Please make it clear what environment variables should be set. It looks like that the Tenderly variables are not enough. For example you also need the HTTP Provider set for each chain (e.g for Fantom HTTP_PROVIDER_250)

Thanks in advance,

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

No branches or pull requests

1 participant