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?

  • PicoBlaanket@lemmy.mlEnglish
    1·
    2 years ago

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

    Good question Charlie Fish :)

    • Charlie FishOPAEnglish
      1·
      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.