Lemmy

12524 readers

1 users here now

Everything about Lemmy; bugs, gripes, praises, and advocacy.

For discussion about the lemmy.ml instance, go to !meta@lemmy.ml.

founded 5 years ago

MODERATORS

nutomic@lemmy.ml

Where is the documentation for the lemmy-js-client located? (eventfrontier.com)

submitted 2 years ago by fishcharlie@eventfrontier.com to c/lemmy@lemmy.ml

3 comments fedilink hide all child comments

I'd love to contribute some improvements to the lemmy-js-client documentation (ex. https://join-lemmy.org/api/interfaces/GetPosts.html), but I can't seem to find the source of that.

I've tried to search in the main Lemmy repo for the comment under community_name to try to give me a pointer, and I can't find any results.

Any ideas where this documentation is even coming from?

top 2 comments

sorted by: hot top controversial new old

[–] picoblaanket@lemmy.ml 1 points 2 years ago* (last edited 2 years ago) (1 children)

The JS-client docs are automatically created by TypeDoc (which takes TypeScript code and generates HTML documentation).

And cool username Charlie Fish :)

[–] fishcharlie@eventfrontier.com 1 points 2 years ago

Ok, but the TypeScript code is generated directly from the Lemmy Rust code (shown here).

But even for community_name the TypeScript file has no comment whereas the documentation does.

So even if the TypeScript files are the source of the documentation (which it doesn't look like it is), it doesn't seem like that is the original source since it's getting generated from Rust. And not quite sure how that process works.

load more comments