search

MainRo / cyclotron-py

A functional and reactive framework
MIT License
37 stars 3 forks source link

Better documentation #2

Open cojua8 opened 1 year ago

cojua8 commented 1 year ago

Hi!,

I've been reading your book on reactive programming, and came to see cyclotron repo. I found that the documentation explains too little and I'm wondering if I can make it a bit better. This is also for the sub-repos (which I think should use the same docs url).

Nice work and thank you for the book!

MainRo commented 1 year ago

Hello,

Yes, I never really took time to write a good doc on it, and even more on the drivers. We should probably get inspiration from the doc of cyclejs (https://cycle.js.org/getting-started.html). Contributions are welcome!

karma0 commented 1 year ago

I just want to throw out that I'd be happy to help document, but I am lacking in getting started.

Perhaps you could lower the barrier of entry for Python developers by adding a bit of anything. I understand some JavaScript, but the gaps between what you have created and what CycleJS is a bit too wide to compare without really trying to dive in on CycleJS which is counterproductive. If that's where one should start, maybe you could be a lot more specific, referencing the documentation that's relevant to how cyclotron works, instead of pointing people to the entire documentation base of CycleJS and directing others learn an entirely different framework in an entirely different language.

The barrier of entry is even higher given that the code is distributed between several projects (http, consul, kafka, -py, _std, etc.). There isn't really a clear delineation between any of them given that none of them are documented.

I too read the book and found the example application really compelling, yet a little difficult to follow without complete code listings or explanation of the mechanics of the underlying cyclotron framework. It looks like exactly what I'm looking for, but I can't say for sure without some clear examples.

Any help would be greately appreciated, even if it's just a bunch of examples, better documentation embedded in the code, references to how things work by providing links to the code itself, links to specific sections in CycleJS that represent relevant ideas or implementations, or even some project documentation generated using an LLM (claude, chat GPT, etc).