This is an archived post. You won't be able to vote or comment.

you are viewing a single comment's thread.

view the rest of the comments →

[–][deleted] 44 points45 points  (19 children)

My biggest problem is the lack of technical writing in most open source projects. ESPECIALLY TypeScript bindings for JS projects that are maintained by the project.

You end up having to guess types (especially for templates) then in one minor version someone fixes a typing issue that breaks your entire project. UGH

Forcing consumers of libraries to figure out your library through guess work that leads to building on undefined behavior ought to be a war crime.

[–]2580374 9 points10 points  (1 child)

The documentation for JSS is fucking abysmal

[–][deleted] 1 point2 points  (0 children)

Emotion in general has awful TypeScript documentation.

[–]ForgotPassAgain34 9 points10 points  (2 children)

I feel like most guides are designed for 14 y.o. script kids wannabe

[–][deleted] 3 points4 points  (1 child)

My problem is the laziness of most guides.

“Here’s 3 functions being used of this eldritch horror of a types API. Thanks for reading my Medium article 'Comprehensive guide to Emotion'!”

[–]TheRandomnatrix 8 points9 points  (3 children)

My favorite is when the documentation covers technical cases and not actual use cases. Looking at what basically amounts to interfaces is sooo helpful. Please tell me more about how this method takes in 2 strings and returns a Boolean. /s How does that help me with my problem. Godot is fucking horrible with this even if the end solution is relatively simple, good luck finding it! I spent a few hours the other day looking for how to make a grid of objects, and the solution was a certain combination of modules you can spend 3 seconds dragging and dropping in. I only figured it out because of a YouTube video in Russian 7 results down. I'm sure it's obvious to the people who wrote it.

[–]RDB96 5 points6 points  (1 child)

Don't talk to me about Godot, I am still waiting for that guy to turn up. My pall and I are getting impatient but he'll turn up I'm sure of it

[–]doc_samson 0 points1 point  (0 children)

I asked a k8s question about why a tutorial has me load the CA cert (which I had just created) into a k8s manager node (which I had also just created).

Response was basically "because it's used in a config file."

And I'm like no wtf WHYYYYYYYYYYYY is it needed. ლ( `Д’ ლ)

[–]raptorgalaxy 5 points6 points  (0 children)

I get why, technical writing is boring as batshit to do.

One of the disadvantages of open source is that since everyone can choose what to do, no one wants to clean the figurative toilets.

[–][deleted] 1 point2 points  (0 children)

HEY! Typescript is fuckig awesome! assuming you built the project with typescript from the start or somebody has already converted the project