search

cirospaciari / socketify.py

Bringing Http/Https and WebSockets High Performance servers for PyPy3 and Python3
https://www.socketify.dev
MIT License
1.38k stars 48 forks source link

API Documentation needs explanations #158

Open domoritz opened 7 months ago

domoritz commented 7 months ago

The API docs at https://docs.socketify.dev/api.html don't describe the parameters or what the methods do.

cirospaciari commented 7 months ago

Yeah and we need a better site too, this is too little information. We should be able to search for something and get the API with description and at least one use case of example.

megaterium commented 7 months ago

If it help, I've created a GPT with the documentation. Might be useful here.

https://github.com/cirospaciari/socketify.py/issues/162#issue-2116693738

greg-martinez44 commented 7 months ago

I can help with docs if this is still available.

avylera commented 7 months ago

Hello, I loved to be assigned to this task!

cirospaciari commented 7 months ago

Everyone can help :D just open a PR and I will take a look to merge it