Improving the docs

[deviantsemicolon]

Is your feature request related to a problem? Please describe.
I am extremely interested in making an astal shell, and I have been for a few months now. But especially as someone who has little typescript knowledge, the docs, specifically the library references, are not particularly helpful. There are little, if any, descriptions for what any of the classes or anything do. This would make coding, for me, a guessing game.

Describe the solution you'd like
I would appreciate it if everything in the library references had proper descriptions that tell you, clearly, what they do. This would make coding a shell in astal much easier.

Describe alternatives you've considered
I could learn typescript enough to analyze the code of astal, but that's not an ideal solution. Not for me, and not for anyone else.

[myamusashi]

Yeah, I really struggled to implement greetd here

[Aylur]

Pretty much everything has a description, but gi-docgen which we use to generate the references doc only puts the property descriptions on the property page and not the generated getter and setter methods which might be confusing.
What might also be confusing is that the references are generated for the C language so learning Typescript won't help you in this case.

I believe that examples teach you better, so I've put as many snippets in the docs as I could and also pushed up some example projects. Since Astal not only supports TypeScript its a huge undertaking to put up an example for each library + supported language + gtk3/gtk4. There are more TS examples planned though.