nidhaloff
help extending the docs
Hello! I'm looking around at open-source projects in need of documentation. Could you tell me a bit more about how to approach this? Have you already implemented an SSG or do your docs live somewhere in this repo?
Also, what would you say are some prerequisites to developing the docs? Anything you think one should be familiar with before tackling this?
@tashachin Hi you are right, I should've explained more what should be done. I was very busy. Basically, what I want to add is more usage examples and documentation about the arguments that can be given to the functions/classes.
I provided some usage examples, however, you can see that it is more of a quick start about what the package can do. Some more optional arguments can be given to the classes or functions like the "publish" or "subscribe" functions. Therefore, it is important to extend the docs by providing these optional args in them (and maybe a description of the optional arguments)
However, feel free to bring new ideas. For example, you can provide more examples (here you will need a basic understanding of what the package is doing). Another example would be to provide general explanation of what the publish/subscribe or RPC patterns are (you can check rabbitmq tutorials for this).
PS: you can find the docs in the docs folder inside the repo. I'm using sphinx to generate docs automatically so you will just add what you want and it will be automatically compiled & deployed if everything is fine.
I want to solve this issue, but where should I start ? And if this is not assigned to anyone? Please assign it to me.
