• drcobaltjedi@programming.dev
      link
      fedilink
      English
      arrow-up
      22
      ·
      1 year ago

      Yeah, that’s a problem with a lot of FOSS passion projects. We devs kinda like writting code, but not really documenting it. Hopefully with the influx of devs helping that will improve

    • tool@r.rosettast0ned.com
      link
      fedilink
      English
      arrow-up
      14
      ·
      1 year ago

      I just wished the Lemmy API docs were better lol.

      Finnegans Wake makes more sense than Lemmy API docs. Even calling it “documentation” is a stretch.

      I literally had to clone the Lemmy git repo and read the source code to find the implementation of an API endpoint and see how it worked for a script that I was writing.

    • Fauzruk@lemmy.world
      link
      fedilink
      English
      arrow-up
      10
      ·
      1 year ago

      These days the standard is to create an API Doc out of a OpenAPI document generated from the code itself. Someone will probably contribute to it at some point.