Skip to content

docs: add bloblang about page with expanded literals section#4051

Open
twmb wants to merge 1 commit intomainfrom
1115
Open

docs: add bloblang about page with expanded literals section#4051
twmb wants to merge 1 commit intomainfrom
1115

Conversation

@twmb
Copy link
Contributor

@twmb twmb commented Mar 2, 2026

Closes #1115

@claude
Copy link

claude bot commented Mar 2, 2026

Claude finished @twmb's task in 1m 59s —— View job


Review

  • Gather context (PR diff, agent files)
  • Validate commit policy
  • Code review
  • Post summary

Commits

LGTM

Review

This PR adds a new Bloblang "about" documentation page via the existing docs_gen template pipeline. The Go changes follow the established pattern (embed → parse → execute → write). The template is static (no {{ }} directives), which is fine and consistent with how the doc generation tool works. The expanded literals section with numbers, booleans, null, strings, triple-quoted strings, arrays, objects, and dynamic expressions is a solid addition.

  1. Broken cross-reference: bloblang_about.adoc.tmpl L17xref:guides:bloblang/about.adoc#interpolation[interpolation] references a #interpolation anchor that does not exist in this page.


A Bloblang mapping defines a transformation that can be applied to messages. Mappings can be added as part of a pipeline with the xref:components:processors/bloblang.adoc[`bloblang` processor] or used directly within many component configurations as an xref:guides:bloblang/about.adoc#interpolation[interpolation] expression.

To run a mapping interactively, try the https://play.benthos.dev[Bloblang playground,window=_blank].
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: This xref references #interpolation, but there is no == Interpolation section or [[interpolation]] anchor defined anywhere in this page. This will be a broken link in the rendered docs. Either add an Interpolation section to this page or update the xref to point to the correct location.


// © 2024 Redpanda Data Inc.

A Bloblang mapping defines a transformation that can be applied to messages. Mappings can be added as part of a pipeline with the xref:components:processors/bloblang.adoc[`bloblang` processor] or used directly within many component configurations as an xref:guides:bloblang/about.adoc#interpolation[interpolation] expression.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bug: This generated file doesn't match the template it's supposed to be generated from. Since doBloblangAbout executes the template with nil data and the template contains no Go template directives, the output should be byte-for-byte identical to bloblang_about.adoc.tmpl.

However, this line has xref:guides:bloblang/about.adoc#interpolation[interpolation] while the template has xref:configuration:interpolation.adoc#bloblang-queries[interpolation].

The generated file should be regenerated from the template (via task docs) to ensure they're in sync.

@claude
Copy link

claude bot commented Mar 16, 2026

Commits
LGTM

Review
The Go code changes follow existing patterns correctly. The generated doc file has a content mismatch with its source template.

  1. Generated file out of sync with template (docs/modules/guides/pages/bloblang/about.adoc#L15): The generated file contains xref:guides:bloblang/about.adoc#interpolation[interpolation] but the template has xref:configuration:interpolation.adoc#bloblang-queries[interpolation]. Since doBloblangAbout passes nil data with no template directives, these must be identical. Re-run task docs to regenerate.

Closes #1115

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@claude
Copy link

claude bot commented Mar 16, 2026

Commits
LGTM

Review
Adds a Bloblang "about" documentation page via the docs generation pipeline: new template, embed directive, template parsing, and generation function in docs_gen/main.go, plus the generated output. Code follows existing patterns for doc generation.

LGTM

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.

Expand bloblang literals docs section

2 participants