ZeldaFan0225 / ai_horde

A package to interact with the stable horde API
MIT License
35 stars 16 forks source link

docs: add auto generated docs #3

Closed MrlolDev closed 1 year ago

ZeldaFan0225 commented 1 year ago

please provide more information on what this pull request adds/changes/is for as well as why this change is needed/requested

MrlolDev commented 1 year ago

Using typedoc I generated new docs for users who want to know what other methods that the package has, Is needed because the actual guide is pretty basic and if you want to know what are the other methods you need to check the types file so this is an easy way.

ZeldaFan0225 commented 1 year ago

i am not familiar with typedoc so please provide how you generated these docs

MrlolDev commented 1 year ago

Typedoc transform the types into markdown documentation where it describes all the methods and properties. It won't affect anything of your work.

MrlolDev commented 1 year ago

You can check it in my fork: https://github.com/MrlolDev/stable_horde