You are viewing a single thread.
View all comments
41 points

I just wished the Lemmy API docs were better lol.

permalink
report
reply
26 points

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

permalink
report
parent
reply
8 points
*

More devs that don’t want to write code?

Edit: damn, meant to say write documentation. We only want to code!

permalink
report
parent
reply
4 points

Well, more devs that have to sit down and figure out how the code works and then document it for future new devs

permalink
report
parent
reply
7 points

I don’t think that is contained to FOSS passion projects ;)

permalink
report
parent
reply
4 points

I don’t really like all the LLM hype, but I’m hoping that documentation will eventually be generated by some open source model, with human verification

permalink
report
parent
reply
4 points
*
Deleted by creator
permalink
report
parent
reply
3 points

I think that this line of reasoning becomes less and less tenable when things like Swagger exist.

permalink
report
parent
reply
3 points

Maybe we’ll eventually get the corresponding influx of tech writers.

permalink
report
parent
reply
1 point

It’s like almost every piece of software, period.

permalink
report
parent
reply
15 points

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.

permalink
report
parent
reply
10 points

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.

permalink
report
parent
reply
9 points

Fediverse software API documentation is bad across all fediverse software.

permalink
report
parent
reply

Lemmy

!lemmy@lemmy.ml

Create post

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

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

Community stats

  • 939

    Monthly active users

  • 646

    Posts

  • 6.8K

    Comments

Community moderators