mxsm/rocketmq-rust
[Docð] Improve rocketmq-namesrv resource config examples
ã¯ããŒãº
#7,622 opened on 2026/06/28
Difficulty level/Easydocumentationðgood first issuerocketmq-namesrv crate
Repository metrics
- Stars
-  (1,484 åã®ã¹ã¿ãŒ)
- PR merge metrics
- Â (PR metrics pending)
説æ
Issue Type
Improvement suggestion
Location
Files: rocketmq-namesrv/README.md, rocketmq-namesrv/README-zh_cn.md, rocketmq-namesrv/resource/namesrv.toml, rocketmq-namesrv/resource/namesrv-example.toml
Description
The README points users to the annotated example config, while resource/namesrv.toml currently contains only a placeholder rocketmqHome=11111. This can confuse first-time users who expect both files to be usable examples.
Suggested Fix
- Clarify the difference between the minimal config and the fully annotated example config.
- Replace the placeholder value in
resource/namesrv.tomlwith a documented minimal example or clearly mark the file as a placeholder. - Keep English and Chinese README guidance aligned.
- Check that the Quick Start commands still point to the intended config file.
Willing to contribute?
- I can submit a PR for this