felixhageloh / uebersicht

ˈyːbɐˌzɪçt

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Übersicht documention and React Newbies

upstageleft opened this issue · comments

First of all, thanks to Felix for this great utility.

The issue here is the user documentation for Übersicht is really confusing for those not already familiar with React and particularly for those not familiar with the recent, object oriented features of JavaScript such as Promises. Also, I hope there will not be another major widget parsing library change anytime soon.

I've had a steep learning curve in the process of replacing all the old coffeescript versions of my widgets with new jsx versions, and it seems from reading through the issues that many features of my experience are not unique. Especially because I am coming from long experience with vanilla procedural Javascript, and only a few years' dabbling in OOP.

Learning the specific syntax of React (which I had never seen before) added a LOT of challenge to learning to use Übersicht, especially because I had written a variety of widgets, some rather complex, and many offering different user-interaction based features. Many of these had been adapted from plain shell script to coffeescript when I switched from GeekTool to Übersicht, and then again to jsx to keep them current and take full advantage of the foreground/background duality featured in recent versions.

It's hard to write really good technical support docs, so I appreciate that this is not a hgh priority or a rewarding task to take on. I just wish to express my support for the idea that better docs make for more and happier users. 😎