Skip to content

Update some command pages to have interactive examples#3608

Open
paoloredis wants to merge 2 commits into
mainfrom
DOC-6826
Open

Update some command pages to have interactive examples#3608
paoloredis wants to merge 2 commits into
mainfrom
DOC-6826

Conversation

@paoloredis

@paoloredis paoloredis commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Note

Low Risk
Documentation-only example formatting with no runtime, API, or build-logic changes beyond Hugo shortcode rendering.

Overview
Replaces static bash/redis-cli transcript blocks on several command reference pages with the {{% redis-cli %}} Hugo shortcode so readers get interactive examples instead of fixed redis> prompts and pasted replies.

Bloom (BF.*) and Cuckoo (CF.*) pages are updated in bulk: examples now list only the commands inside the shortcode (e.g. BF.ADD, CF.INSERT with options). Pages that had multiple highlight blocks—BF.RESERVE, BF.INSERT, CF.INSERT, CF.INSERTNX—use separate shortcode blocks per scenario so success vs error cases stay distinct.

Core commands DIGEST and HEXPIRETIME get the same treatment, moving from fenced code or plain blocks to redis-cli shortcodes. Command semantics and return-info sections are unchanged; only the Examples section format changes.

Reviewed by Cursor Bugbot for commit dae9ded. Bugbot is set up for automated code reviews on this repo. Configure here.

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

DOC-6826

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit 0f23c21. Configure here.

Comment thread content/commands/bf.add.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants