stable-diffusion-webui-forge icon indicating copy to clipboard operation
stable-diffusion-webui-forge copied to clipboard

[Feature Request]: Proper Documentation

Open Gothmoth88 opened this issue 1 year ago • 1 comments

Is there an existing issue for this?

  • [X] I have searched the existing issues and checked the recent builds/commits

What would your feature do ?

you do great work but a lot of this work is wasted without proper documentation. for example the intergrated hiresfix is different to the original one from kohya. it has different options, i have no clue what the sliders do in the forge implementation. and that is just one example.

you want to improve webui, to make it better. an important part to actually make it better is a detailed documentation of what the options do.

i get that writing documentation is not as fun as including new features. but it is an important part of making a program usable and BETTER.

instead of 20.000 people wasting their time trying to figure stuff out... it would be a better approach if someone who knows this stuff spends some time explaining it.

explaining it in non-coder language. i don´t need to know the math or process behind every slider in detail. but at least i need to know what the slider does to the image creation. how to use it for my benefit.

excuse me if i such a documentation exists and i missed it. i searched but i did not find it.

Proposed workflow

  1. Go to ....
  2. Press ....
  3. ...

Additional information

No response

Gothmoth88 avatar Feb 18 '24 16:02 Gothmoth88

@Gothmoth88 As a tip / suggestion for documenting UI's

Make a voice recording describing the page and every UI element and what it does.

Then convert it to text using whisper and pass it to GPT4 to write out full documentation for each feature and page with headers titles and explainers.

At that point you can also at all that information into a GPT assistant (for those who have GPT Plus)

meanin2 avatar Feb 20 '24 08:02 meanin2