Repository navigation
feat: add hover tooltips for blobl, connect and rpkcmd references - #457
Draft
JakeSCahill wants to merge 2 commits into
Draft
JakeSCahill wants to merge 2 commits into
JakeSCahill wants to merge 2 commits into
Conversation
Decorate the inline references the blobl:, connect: and rpkcmd: macros emit (code.bloblang-call, code.connect-component, code.rpk-command) with tippy tooltips built only from the published data. A missing dataset or entry means no tooltip. - Bloblang reuses 16-bloblang-interactive.js: one shared Connect JSON request and the same renderer as code blocks. The renderer now shows parameter defaults and no longer invents a return type or description. Inline tooltips ignore the hand-written bloblang-docs.json fallback. - Connect reads the same connect-json-url data: name, type, status badge and summary for a component; path, type, default and first sentence for a field. - rpk reads a new rpk-json-url meta, resolved from rpk-<tag>.json in streaming the same way the properties tag is chosen. - Per-family off switches: page-disable-bloblang-tooltips, page-disable-connect-tooltips and page-disable-rpk-tooltips. The tests run against preview-src/_data, Connect and rpk fixtures trimmed from connect-4.115.1.json and rpk-v26.2.2.json.
Two preview pages cover every case with the macros' real HTML output, each with a note on what hover should show. The preview build copies the preview-src/_data fixtures to the UI root, where the tooltip scripts look in preview mode, so they never ship in the bundle.
✅ Deploy Preview for docs-ui ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: true
Comment |
This was referenced Nov 11, 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.

Adds hover tooltips to the inline references that the new
blobl:,connect:andrpkcmd:macros emit (docs-extensions-and-macros #458), in the same way property tooltips work forprop:.Returns: any.rpk-json-urlmeta, resolved from streaming'srpk-<version>.jsonattachment (docs #2255) the same way asproperties-json-url.:page-disable-bloblang-tooltips:,:page-disable-connect-tooltips:,:page-disable-rpk-tooltips:.macro-tooltips-testcovers every case, andmacro-tooltips-off-testcovers the off switches. Both use trimmed real data fixtures that are served only in the preview.Nothing changes on live pages until #458 ships the macros. rpk tooltips also need docs #2255 to publish the rpk data.
Testing
npx gulp lintpasses.tests/macro-tooltips(12 tests) and the 5 newtests/head-metatests pass, with negative controls.test:interactivefailed once and then passed on four reruns.npx gulp preview:buildhangs incompile:widgetslocally (antora.yml 404); the build and preview-pages tasks run fine directly.