open-telemetry/opentelemetry-ruby-contrib
Improve configuration documentation
オープン
#876 opened on 2024/02/20
documentationhelp wantedkeep
Repository metrics
- Stars
- (135 個のスター)
- PR merge metrics
- (PR metrics pending)
説明
YARD/RDoc doesn't provide a great way for us to add documentation for our configuration options
Ideas:
- Automate addition of config documentation to READMEs for individual gems
- Automate a section in
instrumentation-allthat lists the config options for all the gems that get installed
See #825 as one example for README-style documentation