v2-sdk icon indicating copy to clipboard operation
v2-sdk copied to clipboard

generate versioned documentation from the library code

Open NoahZinsmeister opened this issue 4 years ago • 2 comments

manual updates to reference documentation is not very robust, and can lead to problems such as #28.

we should migrate to tsdoc to document code, and possibly typedoc to generate reference material to be incorporated into uniswap.org

NoahZinsmeister avatar Jul 13 '20 14:07 NoahZinsmeister

Sounds like it'll generate .md files and we can copy them over?

callil avatar Jul 15 '20 17:07 callil

Copying them over is not ideal since we still only represent a single version and it requires manual work, ideally there is a documentation site for each NPM package version that fully documents the classes and methods available in the SDK (generated from inline documentation of the code)

moodysalem avatar Mar 07 '21 18:03 moodysalem