ui icon indicating copy to clipboard operation
ui copied to clipboard

Approaching a documentation

Open fnetX opened this issue 4 years ago • 3 comments

Hello there,

I'm new to UI programming in general, and I'm considering to start with V UI instead of GTK etc ... but there's something keeping me off: the lack of any documentation. I was quite struggling with some examples at first.

While I perfectly understand there are no docs at this early stage, because it's usually really annoying to write them, I want to point out my experience that writing docs along the code results in far better docs than adding them afterwards.

So I hereby request some kind of docs for this project to provide early adopters with a way to use and improve it.

I think, maintaining flexible docs is necessary, so I propose to use the awesome HedgeDoc software to create a flexible Markdown document which is easy to update and later committed to this repo. The document can be published read-only for the world and an edit link can be shared between maintainers.

I'm glad if I can help by writing most of it as I learn by the examples as long as you are there to check it for correctness and answer any questions I might have.

Thank you. :v:

fnetX avatar Feb 14 '21 20:02 fnetX

I think ui is not matured to be documented publicly.

ghost avatar Feb 15 '21 08:02 ghost

I still think it has a higher chance of finding contributors when starting with it is easier :shrug:

fnetX avatar Mar 07 '21 17:03 fnetX

I am a pure beginner and very interested to play with ui , and I also wish there was a basic documentation about each functions... chatGPT 3.5 keeps writing garbage and commands that doesn't exist. no help from there!

osascruz avatar Oct 16 '23 15:10 osascruz