Documentation unclear

[fresheneesz]

What does this module do? All I can tel from the readme is that this is meant to be used on a REPL, but opening a REPL with "with access to all variables" means literally nothing to me. Please clarify. The example with a screenshot didn't help..

[fresheneesz]

Ohh, I see. When running the script, it will open a REPL inside that program with access to all the top-level variables. I get it now. The docs are still unclear.

[alidavut]

You are right. I'm going to work on it, thanks!

[alidavut]

Added a video session

[fresheneesz]

I don't consider video session documentation. Is the text-documentation clear about this now?

[alidavut]

Ok ok I will improve it :)

[fresheneesz]

I think users of this module would appreciate it : )

[slavaGanzin]

It's mean in open source community when somebody think that owner of project "own something".
If you don't like - contribute yourself.

[fresheneesz]

@slavaGanzin I contribute in my own way. If you want to see how check my repos:

• https://github.com/fresheneesz?utf8=%E2%9C%93&tab=repositories&q=&type=source&language=
• https://github.com/Tixit

Commenting on needed improvements and found bugs etc is also contributing. So don't spend all that time that you could be using to contribute to open source on top that high horse there, bro.

[mirandashort]

Has there been any progress made on documentation? The video session is helpful but it's difficult to take things step by step and is hard to pace. Even something that's the same exact steps of the video session in markdown rather than a gif would be super helpful. I keep missing a key part of the video and have to refresh and start all the way from the beginning 😞

Also @slavaGanzin this is a place to open up discussion for collaboration and contribution. It's very hard for anyone to be able to contribute without a basic understanding of how to use the module, so this issue is meant to resolve that. As far as I'm considered, the owner of the project does own the task for documentation until someone contributes something that requires them to update the documentation.