Request for more comprehensive documentation

[korir248]

Is your feature request related to a problem? Please describe.

Hello,

I've been using this repository and find it very useful. However, I've noticed that the documentation could be improved to better assist new users and developers.

Describe the solution you'd like

Specifically, I believe the following areas could benefit from more detailed documentation:

• API Documentation: Detailed descriptions of the project's API, including examples of how to use different functions or methods.

• Configuration Options: A comprehensive list of configuration options available, along with explanations of what each option does and how to set it.

• Troubleshooting Guide: Common issues and their solutions, including error messages and how to resolve them.

Describe alternatives you've considered

No response

Additional context

No response

[lukebakken]

Hello! Thanks for using the tutorials.

I have converted your issue to a discussion as we prefer to use discussions to, well, discuss things before actual work is done.

As you've seen, ALL of the software and documentation you are using are open-source, and available to you for free. Team RabbitMQ would appreciate it if you took the time to improve the documentation yourself.

In your specific case, it would be helpful to know the following:

• What programming language are you using?
• What, SPECIFICALLY did you find lacking in the documentation and tutorials? Your list of suggestions is far too broad to be useful to us.

[korir248]

Hello. I am using Rust. Specifically using the lapin crate. The tutorials are nicely done and accurately do what they are meant to. However, Rust is not among them unfortunately. To my understanding, this is not a major issue as the other tutorials give the information required to start building.The API docs is where the issue is. It makes it a challenge to accurately tell what a function or method does, what its inputs refer to or any code snippets that might help in that

[michaelklishin]

Documentation usually consists of three parts:

• Tutorials
• More detailed guides
• API reference

RabbitMQ has tutorials for more than 10 programming languages, more detailed guides for Java and .NET clients, and general language-neutral guides like Publishers and Consumers.

API reference is also available for Java and .NET, and the client API surface is so small that arguably they do not add that much value, except for a couple of functions (to publish and register a consumer).

Our team does not have the resources to produce similar doc guides for 10+ client libraries but all docs are open source and everyone is welcome to contribute them. Note that we will apply the same quality and completeness standards for anything we put out there on rabbitmq.com but for clients such as Pika or amqplib (Node.jS), the docs usually reside in their respective repositories and have different standards and structure.

[korir248]

I understand that providing docs for all languages supported is no easy task. I was asking if the API documentation for Rust could be improved

[lukebakken]

I suggest asking the lapin library maintainers:

https://github.com/amqp-rs/lapin

[michaelklishin]

We do not maintain Lapin. In fact, some members of our team strongly prefer and have contributed to a different Rust client: https://github.com/gftea/amqprs.

Both clients are open source, so if something is lacking, it can be added by their respective user communities. This is open source software after all, not "free labor" software.

[korir248]

Thanks. Realized that lapin isn't maintained by you guys. Sorry about that @lukebakken @michaelklishin. The Rust tutorial on the site could be improved though. I know its not free labour but it would really help Rust devs everywhere

[korir248]

Will look at it. Many thanks