docs(config): add yaml-example doc-generator output and document V2 config blocks#5151
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is ON, but it could not run because the branch was deleted or merged before autofix could start.
Reviewed by Cursor Bugbot for commit 5af55f2. Configure here.
…onfig blocks Adds a -format=yaml-example mode to the doc-generator and wires it into the Makefile so cmd/pyroscope/pyroscope.yaml is regenerated automatically. Registers the V2 root blocks (segment_writer, metastore, compaction_worker, query_backend, adaptive_placement, symbolizer, overrides_exporter) and removes the doc:"hidden" tags hiding them, so they appear in both the generated reference docs and the example config.
5af55f2 to
4a83641
Compare
simonswine
commented
May 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
Picks up the work from @alliasgher in #5106:
-format=yaml-examplemode to the doc-generator and wires it into the Makefile socmd/pyroscope/pyroscope.yamlis regenerated automatically.segment_writer,metastore,compaction_worker,query_backend,adaptive_placement,symbolizer,overrides_exporter) and removes thedoc:"hidden"tags hiding them, so they appear in both the generated reference docs and the example config.Credit: @alliasgher (original PR: #5106).
Test plan
make generateproduces no diff on a clean treecmd/pyroscope/pyroscope.yamlreflects the V2 blocksdocs/sources/configure-server/reference-configuration-parameters/index.mdrenders the new blocksNote
Low Risk
Low risk: changes are confined to documentation generation and example config output, with no impact to runtime behavior besides exposing previously hidden config fields in generated docs.
Overview
Adds a new
-format yaml-examplemode totools/doc-generator(with-skip-blocks) to emit a commented YAML config example using default values and only basic fields.Wires this into
make generateto auto-regeneratecmd/pyroscope/pyroscope.yaml, and updates the generated reference docs to include previously hidden V2 top-level blocks (metastore,segment_writer,compaction_worker,query_backend,adaptive_placement,symbolizer,overrides_exporter) plus category annotations like (advanced)/(experimental).Reviewed by Cursor Bugbot for commit 4a83641. Bugbot is set up for automated code reviews on this repo. Configure here.