Top-gg-Community / node-sdk

An official module for interacting with the Top.gg API
https://topgg.js.org/
133 stars 42 forks source link

Replaced `client` with `api` #51

Closed EhsanFox closed 3 years ago

EhsanFox commented 3 years ago

Replaced client with api since it's what it's called at the beginning (kinda dumb idk)

jpbberry commented 3 years ago

Please set these documentations inside of the JSDOC in the src/, then run npm run build to build the docs rather than editing the build.

velddev commented 3 years ago

Unrelated, but can't we move these docs to top-gg/docs?

EhsanFox commented 3 years ago

couldn't find the JSDOC (maybe a direct link can be useful) also, I didn't find anything about the https://topggjs.readthedocs.io/en/latest/Api.html to edit as the same as the Api.md file that I just edited....

jpbberry commented 3 years ago

Unrelated, but can't we move these docs to top-gg/docs?

Moving them would mean we would need to auto-build them, if you want that then sure, but the current jsdocs are currently just passed to https://topggjs.rtfd.io

jpbberry commented 3 years ago

couldn't find the JSDOC (maybe a direct link can be useful)

https://github.com/top-gg/node-sdk/blob/master/src/structs/Api.ts#L77

velddev commented 3 years ago

Moving them would mean we would need to auto-build them, if you want that then sure, but the current jsdocs are currently just passed to https://topggjs.rtfd.io

Ah I see, it's generated docs. Might be interesting to have this be done in the future @Xetera. Especially with the search bar you've added we could get a lot more docs in now :)

EhsanFox commented 3 years ago

Please set these documentations inside of the JSDOC in the src/, then run npm run build to build the docs rather than editing the build.

I just edited the structures too ( unfortunately I can not npm run build at this moment! )

EhsanFox commented 3 years ago

i will close this pull request and u can check the other one for both edits

EhsanFox commented 3 years ago

https://github.com/top-gg/node-sdk/pull/52