Supplement the documentation with examples

[Andredron]

Good afternoon, very often there are sections of documentation where there are no examples, and you have to touch on a huge loss of time to find information on it.

We all want our code to be cleaner and more productive, and with examples we will be able to get closer to this result.

And let's not forget about reliability and clarity. As an example with text size and font selection, there used to just be a link, but after a bunch of complaints and whining, the documentation was updated and there appeared last year examples of font size and font selection.

https://www.renpy.org/doc/html/gui_adva ... ml#example

We leave the documentation without examples, we hope that users will figure it out for themselves. But why not do more? By keeping the added example in a convenient place, we automatically eliminate potential errors, we create documentation that creates an amazing impression and preserves our concern for users.

I would like our documentation to follow the credo "More examples – more clarity". Let's make our ultimate goal – to help people understand and use information – achievable and easy!

https://www.renpy.org/doc/html/updater.html and https://www.renpy.org/doc/html/live2d.html

Here is for comparison the update online and life2d, compare how in one it is simply written that it is possible, and in the second it is painted in detail, which will help users use examples faster!

https://www.renpy.org/doc/html/other.html#renpy.is_seen - Zero examples and guess how to do it, the benefit of the Chinese helped

https://www.renpy.cn/forum.php?mod=view ... a=page%3D1

[ISAWHIM]

I love the "dig deeper to get more dirty" style of help documents.

There is a lot of open-ended and "assumed knowledge", required when trying to rifle through help, making it really, not much help at all, in many places.

With all that is changing, and many things being replaced by new systems that no longer support the old code, except for some kind of limited "reverse compatibility"... We really need the "laymen's terms" and the "simpleton's comments", which are just not present, anywhere, in any of the code. (As if we are all developers of code and RenPy, and just :know all of this, and the deep nested, hidden source-code, driving the super-simplified code samples that RenPy uses to do what it does.)

I suggested that the help section have some kind of "page suggestions", where users could submit inclusions or note errors, or demand elaboration where needed. This being a way to get some free labor and "views from those USING the help files", to better determine what is NEEDED as HELP.

The current system isn't working. The code provided, in many cases, doesn't even work. None of it currently matches the actual included code that the "default project" creates. So, we can't even use that as a comparison.

Google once worked well, to help, but now many of the old forum posts that google once thought were "great solutions", are no longer working for ANY solutions now. (Not for the two latest versions, which both have many small changes that make this old code non-functional as a solution.)

[PyTom]

If people want to contribute to the documentation, please make pull requests on github.