How do you ACTUALLY make your code readable 📖 for others? 🤷‍♂️

For me, sometimes documentation lacks variations for some let's say component. It assumes that you know how to use it and they just mention - yeah, put padding: true if you want padding... Put? Where? Dude? How do I even start.

At least I'm that kind of "learner", let me see how it works together, and I'll figure out how to use it. I can't compile all of bullet points and then think about how to start writing from the scratch. I'm not talking about your product, but my frustration with some documentation.

I mean, most of the times we stumble upon some library that we never used before (nor probably will use on a regular basis), and 99% of the code is new to us. some concepts are new to us. maybe, let's say you're creating a react library, and you're having higher order component applied to your solution and it's perfectly natural for you how it works, but you need to take into account that most users don't know for example how HOC works and they are more confused, because they don't know is it your code, or HOC code if you get me.

If you document your code, document a lot of variations. don't clutter the space, find a way how to put it together somewhere, but please if you have x variations of usage, provide x fully working demo examples..

just my 2c on the documentation topic

what does buildfaster do?