Skip to content
This repository has been archived by the owner on Apr 25, 2024. It is now read-only.

generate versioned documentation from the library code #29

Open
NoahZinsmeister opened this issue Jul 13, 2020 · 2 comments
Open

generate versioned documentation from the library code #29

NoahZinsmeister opened this issue Jul 13, 2020 · 2 comments

Comments

@NoahZinsmeister
Copy link
Contributor

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

@callil
Copy link

callil commented Jul 15, 2020

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

@moodysalem moodysalem changed the title migrate to versioned, inline docs generate versioned documentation from the library code Mar 7, 2021
@moodysalem
Copy link
Contributor

moodysalem commented Mar 7, 2021

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)

royalaid pushed a commit to royalaid/qidao-sdk that referenced this issue Dec 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants