Skip to content

docs(apidoc): transform Go map syntax to JSON-like format#39

Merged
gbartolini merged 1 commit intomainfrom
dev/apidoc-fix-map-syntax
Jan 21, 2026
Merged

docs(apidoc): transform Go map syntax to JSON-like format#39
gbartolini merged 1 commit intomainfrom
dev/apidoc-fix-map-syntax

Conversation

@mnencia
Copy link
Copy Markdown
Member

@mnencia mnencia commented Jan 20, 2026

Transform Go map representation (map[key:value]) to JSON-like syntax ({ key:value }) in generated API documentation, making default values more intuitive for users unfamiliar with Go.

This change applies the fix from cloudnative-pg/cloudnative-pg#9777 to all versioned documentation (1.25, 1.26, 1.27, 1.28) and the development version.

The specific change transforms the replicationSlots default value from:

\{ highAvailability:map[enabled:true] \}

to:

\{ highAvailability\: \{ enabled:true \} \}

This resolves Docusaurus v3 rendering issues where the :map portion was being misinterpreted as a Markdown directive and removed from the rendered output.

Transform Go map representation (map[key:value]) to JSON-like
syntax ({ key:value }) in generated API documentation, making
default values more intuitive for users unfamiliar with Go.

This change applies the fix from cloudnative-pg/cloudnative-pg#9777
to all versioned documentation (1.25, 1.26, 1.27, 1.28) and the
development version.

Signed-off-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com>
@mnencia mnencia requested review from a team and SaxenaAnushka102 as code owners January 20, 2026 17:48
@gbartolini gbartolini merged commit 3ea1724 into main Jan 21, 2026
4 checks passed
@gbartolini gbartolini deleted the dev/apidoc-fix-map-syntax branch January 21, 2026 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants