docs: align command reference and operational guides with Dragonfly v1.40.0

[vyavdoshenko]

Update the documentation for Dragonfly v1.40.0 and correct inaccurate changes produced by automated synchronization.

Changes:

• Add command pages for BF.INFO, HGETEX, HPEXPIRETIME, and RESET.
• Update the compatibility table with new commands, supported options, and v1.40.0 verification.
• Correct WAIT, replication, and cluster migration examples using topology-aware testing.
• Document experimental cascading replication and replica expiration behavior.
• Update Search documentation with new vector types, distance metrics, HNSW options, scorers, and accurate FT.INFO output.
• Refresh Cuckoo Filter documentation, including ACL categories, outputs, complexity, compaction, sizing, and expansion behavior.
• Update Count-Min Sketch ACL categories and ACL DRYRUN syntax.
• Document new, removed, and changed configuration flags and defaults.
• Update INFO, monitoring, tiering, and cluster-mode documentation.
• Replace outdated Redis references with Valkey documentation.
• Fix command prompts, internal links, wording, and formatting.

Validation:

• Verified affected commands using Dragonfly v1.40.0.

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
documentation	Ready	Preview	Aug 4, 2026 12:54pm

[qodo-free-for-open-source-projects]

PR Summary by Qodo

Docs: align command reference and guides with Dragonfly v1.40.0

📝 Documentation 🕐 40+ Minutes

AI Description

• Add v1.40.0 command docs for BF.INFO, HGETEX, HPEXPIRETIME, and RESET.
• Refresh compatibility table, ACL categories, complexities, and corrected command examples.
• Update operational guides (cluster, replication, flags, monitoring, tiering) for v1.40 behavior.

Diagram

graph TD
  v140{{"Dragonfly v1.40.0"}} --> docs["Docs site"] --> cmdref["Command reference"] --> newpages["New command pages"]
  cmdref --> compat["compatibility.md"]
  cmdref --> searchdocs["Search (FT.*) docs"]
  docs --> guides["Managing Dragonfly guides"]
  guides --> flags["flags.md"]

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Generate command reference from server metadata

• ➕ Reduces drift between implementation and docs (options, ACL categories, complexity).
• ➕ Enables automated validation of example outputs and supported selectors.
• ➖ Requires adding/maintaining structured metadata in the server codebase.
• ➖ Does not cover operational guide narratives (replication, tiering, cluster).

2. Add a docs CI “example verifier” suite

• ➕ Catches stale prompts/output (e.g., error strings, FT.INFO layout) early.
• ➕ Encourages topology-aware testing for cluster/replication examples.
• ➖ Non-trivial to stabilize outputs across environments and timing-dependent commands.
• ➖ Increases CI runtime and requires harness maintenance per release.

3. Versioned documentation per Dragonfly minor release

• ➕ Avoids confusing users on older versions when behavior changes (e.g., replica expiration).
• ➕ Makes compatibility notes more discoverable and historically accurate.
• ➖ Higher maintenance burden and more complicated navigation/SEO.
• ➖ Requires discipline to backport doc fixes across versions.

Recommendation: The PR’s approach (manual, targeted corrections plus new pages) is the right near-term move for v1.40.0 readiness because it fixes known sync inaccuracies and aligns examples with verified behavior. Consider follow-up work to (1) derive command-surface details from structured server metadata and/or (2) add lightweight CI verification for a small set of critical examples (RESET, FT.INFO output shape, cluster migration status), which are the most likely to drift again.

Files changed (33) +623 / -224

Documentation (33) +623 / -224

dryrun.mdClarify ACL DRYRUN syntax and argument handling +3/-3

Clarify ACL DRYRUN syntax and argument handling

• Updates syntax to reflect that ACL DRYRUN can simulate commands with arguments. Adjusts description wording and normalizes the error example to match command casing.

docs/command-reference/acl/dryrun.md

bf.info.mdAdd BF.INFO command page with selector compatibility notes +79/-0

Add BF.INFO command page with selector compatibility notes

• Introduces a new BF.INFO reference page, documenting selectors, replies, and examples. Includes a Dragonfly v1.40.0 compatibility note highlighting unsupported Valkey selectors.

docs/command-reference/bloom-filter/bf.info.md

dflycluster-slot-migration-status.mdUpdate slot migration status fields, complexity, and example output +9/-7

Update slot migration status fields, complexity, and example output

• Refines time complexity to account for migrations and slot ranges. Expands returned fields to include slot-range strings and updates the example to match topology-aware output.

docs/command-reference/cluster-management/dflycluster-slot-migration-status.md

compatibility.mdRefresh compatibility matrix for v1.40.0 and new commands +12/-6

Refresh compatibility matrix for v1.40.0 and new commands

• Adds command-surface compatibility guidance and updates verification to Dragonfly v1.40.0. Marks RESET supported, adds HGETEX/HPEXPIRETIME, changes BF.INFO to partial support with missing selectors, and clarifies FT.HYBRID missing options; also renames the CF family to Cuckoo Filter.

docs/command-reference/compatibility.md

cms.incrby.mdCorrect CMS.INCRBY ACL categories to include write +1/-1

Correct CMS.INCRBY ACL categories to include write

• Updates ACL categories to include @write, aligning permissions with mutating behavior.

docs/command-reference/count-min-sketch/cms.incrby.md

cms.initbydim.mdCorrect CMS.INITBYDIM ACL categories to include write +1/-1

Correct CMS.INITBYDIM ACL categories to include write

• Updates ACL categories to include @write, reflecting that initialization creates/changes state.

docs/command-reference/count-min-sketch/cms.initbydim.md

cms.initbyprob.mdCorrect CMS.INITBYPROB ACL categories to include write +1/-1

Correct CMS.INITBYPROB ACL categories to include write

• Updates ACL categories to include @write, reflecting that initialization creates/changes state.

docs/command-reference/count-min-sketch/cms.initbyprob.md

cms.merge.mdCorrect CMS.MERGE ACL categories to include write +1/-1

Correct CMS.MERGE ACL categories to include write

• Updates ACL categories to include @write, aligning permissions with the destination mutation.

docs/command-reference/count-min-sketch/cms.merge.md

cf.add.mdUpdate CF.ADD ACL categories and naming +1/-1

Update CF.ADD ACL categories and naming

• Renames ACL category to @cuckoo_filter and adds @slow/@write to match observed behavior classification.

docs/command-reference/cuckoo-filter/cf.add.md

cf.addnx.mdUpdate CF.ADDNX ACL categories and naming +1/-1

Update CF.ADDNX ACL categories and naming

• Renames ACL category to @cuckoo_filter and adds @slow/@write to match observed behavior classification.

docs/command-reference/cuckoo-filter/cf.addnx.md

cf.compact.mdDocument CF.COMPACT compaction mechanics and worst-case cost +10/-7

Document CF.COMPACT compaction mechanics and worst-case cost

• Updates complexity to worst-case slot-scan behavior and rewrites compaction description to explain fingerprint movement and sub-filter removal constraints. Normalizes error example formatting to 'ERR no such key' and updates ACL categories.

docs/command-reference/cuckoo-filter/cf.compact.md

cf.count.mdClarify CF.COUNT return behavior and ACL categories +2/-2

Clarify CF.COUNT return behavior and ACL categories

• Updates ACL categories to @cuckoo_filter/@fast/@read and clarifies that non-existent keys or wrong types return 0.

docs/command-reference/cuckoo-filter/cf.count.md

cf.del.mdDocument CF.DEL compaction-triggered complexity and errors +3/-3

Document CF.DEL compaction-triggered complexity and errors

• Expands complexity notes to include automatic compaction worst-case behavior. Updates ACL categories and normalizes the missing-key error example to 'ERR no such key'.

docs/command-reference/cuckoo-filter/cf.del.md

cf.exists.mdClarify CF.EXISTS return behavior and ACL categories +2/-2

Clarify CF.EXISTS return behavior and ACL categories

• Updates ACL categories to @cuckoo_filter/@fast/@read and clarifies that non-existent keys or wrong types return 0.

docs/command-reference/cuckoo-filter/cf.exists.md

cf.info.mdCorrect CF.INFO complexity and field semantics with updated examples +9/-9

Correct CF.INFO complexity and field semantics with updated examples

• Updates complexity to O(k) and refines descriptions of buckets/filters/deletions/expansion rounding. Updates example output values and normalizes missing-key error formatting.

docs/command-reference/cuckoo-filter/cf.info.md

cf.insert.mdUpdate CF.INSERT ACL categories and error examples +2/-2

Update CF.INSERT ACL categories and error examples

• Renames ACL category to @cuckoo_filter and adds @slow/@write; normalizes missing-key error output to 'ERR no such key'.

docs/command-reference/cuckoo-filter/cf.insert.md

cf.insertnx.mdUpdate CF.INSERTNX ACL categories and error examples +2/-2

Update CF.INSERTNX ACL categories and error examples

• Renames ACL category to @cuckoo_filter and adds @slow/@write; normalizes missing-key error output to 'ERR no such key'.

docs/command-reference/cuckoo-filter/cf.insertnx.md

cf.mexists.mdClarify CF.MEXISTS return behavior and ACL categories +2/-2

Clarify CF.MEXISTS return behavior and ACL categories

• Updates ACL categories to @cuckoo_filter/@fast/@read and clarifies that non-existent keys or wrong types return 0 per item.

docs/command-reference/cuckoo-filter/cf.mexists.md

cf.reserve.mdClarify CF.RESERVE sizing/expansion semantics and error formatting +5/-5

Clarify CF.RESERVE sizing/expansion semantics and error formatting

• Reframes capacity as a sizing estimate and documents bucket rounding and expansion rounding behavior. Updates ACL categories and normalizes errors to 'ERR item exists'.

docs/command-reference/cuckoo-filter/cf.reserve.md

wait.mdCorrect WAIT complexity description +1/-1

Correct WAIT complexity description

• Replaces constant-time claim with a complexity note that depends on replicas/shards and wait duration.

docs/command-reference/generic/wait.md

hgetex.mdAdd HGETEX command page with expiration precision notes +85/-0

Add HGETEX command page with expiration precision notes

• Introduces a new HGETEX reference page covering expiration options, semantics (including deletion on 0/past expiry), and return behavior. Documents Dragonfly’s whole-second hash-field expiration precision and max-future TTL constraint, with examples.

docs/command-reference/hashes/hgetex.md

hpexpiretime.mdAdd HPEXPIRETIME command page with precision details +71/-0

Add HPEXPIRETIME command page with precision details

• Introduces a new HPEXPIRETIME reference page describing millisecond Unix timestamps, -2/-1 semantics, and error cases. Notes Dragonfly’s whole-second quantization and provides examples.

docs/command-reference/hashes/hpexpiretime.md

ft.aggregate.mdDocument additional scorers and BM25STD tanh factor; update Valkey links +5/-3

Document additional scorers and BM25STD tanh factor; update Valkey links

• Adds BM25STD_TANH_FACTOR and expands supported scorers to include BM25STD variants. Updates vector-query notes and replaces Redis links with Valkey Search references.

docs/command-reference/search/ft.aggregate.md

ft.create.mdExpand FT.CREATE schema/vector option docs and align external references +17/-17

Expand FT.CREATE schema/vector option docs and align external references

• Documents TEXT WEIGHT/NOSTEM options and updates guidance links to Valkey Search. Expands VECTOR option coverage to include TYPE, IP distance, and additional HNSW parameters; clarifies SORTABLE requirements and updates ignored-option notes.

docs/command-reference/search/ft.create.md

ft.info.mdCorrect FT.INFO complexity and output structure with updated example +30/-22

Correct FT.INFO complexity and output structure with updated example

• Updates complexity note and clarifies that FT.INFO returns a flat array under RESP2/RESP3. Expands field descriptions (definition/options/attributes) and updates example output to match current behavior, including non-deterministic attribute ordering guidance.

docs/command-reference/search/ft.info.md

ft.search.mdUpdate FT.SEARCH vector query, scoring, and complexity documentation +15/-11

Update FT.SEARCH vector query, scoring, and complexity documentation

• Adds BM25STD_TANH_FACTOR, expands supported scorers, and rewrites vector search section to cover FLAT/HNSW, EF_RUNTIME/EPSILON overrides, and query composition constraints. Updates complexity guidance and switches references to Valkey Search links.

docs/command-reference/search/ft.search.md

info.mdUpdate INFO sections, default output, TLS certificate note, and complexity +9/-3

Update INFO sections, default output, TLS certificate note, and complexity

• Replaces O(1) complexity with a section-dependent note and adds TLS listener certificate fields for the server section. Adds latencystats section, clarifies default output contents, and updates the example to include a Latencystats header.

docs/command-reference/server-management/info.md

reset.mdAdd RESET command page with connection-state semantics and compatibility note +79/-0

Add RESET command page with connection-state semantics and compatibility note

• Introduces a new RESET reference page enumerating connection-scoped state cleared by RESET (transactions, pubsub, monitor, tracking, DB, RESP version, auth). Adds a v1.40 compatibility note about CLIENT SETNAME preservation and includes examples.

docs/command-reference/server-management/reset.md

cluster-mode.mdRefine cluster mode guidance and align links/prompts to Valkey +8/-5

Refine cluster mode guidance and align links/prompts to Valkey

• Fixes shell prompt formatting and updates cluster spec/hashtag links to Valkey. Adds runtime CONFIG SET note for announce settings in emulated mode, clarifies multi-shard DB 0 limitation, and improves wording/typos.

docs/managing-dragonfly/cluster-mode.md

flags.mdUpdate server flags for v1.40: new flags, removed flags, and default changes +129/-92

Update server flags for v1.40: new flags, removed flags, and default changes

• Adds new flags (e.g., snapshot_egress_limit_bytes, pubsub_slow_subscriber_timeout_ms, tiered_min_ttl_to_offload_ms, tiering_disk_storage_initial_size, list compression settings, enable_pipeline_squashing_v2, experimental_cascaded_partial_sync, get_zero_copy, pipeline_parse_in_proactor, pipeline_prioritize_large_batches, write_connection_throttling_sleep_usec). Removes/marks deprecated entries (e.g., experimental_replicaof_v2, oom_deny_commands, squash_stats_latency_lower_limit) and updates multiple defaults and descriptions for accuracy.

docs/managing-dragonfly/flags.md

monitoring.mdClarify monitoring endpoints and metrics coverage +2/-2

Clarify monitoring endpoints and metrics coverage

• Refines HTTP/Prometheus endpoint description and adds notes about connection/pipeline metrics and batch I/O counters. Expands replication metrics description to include replication backlog.

docs/managing-dragonfly/monitoring.md

replication.mdDocument experimental cascaded replication and replica expiration behavior change +24/-10

Document experimental cascaded replication and replica expiration behavior change

• Switches replication references to Valkey, fixes prompt formatting, and documents experimental cascaded partial sync behind a v1.40.0 flag. Updates replica expired-key behavior description (default proactive deletion on reads; flag disables) and keeps TLS examples consistent.

docs/managing-dragonfly/replication.md

tiering.mdFix internal link and document list-node prefetch behavior +2/-2

Fix internal link and document list-node prefetch behavior

• Corrects the proactor thread link to a relative docs path. Expands tiering limitations section to document list-node prefetching behavior controlled by list_tiering_prefetch_depth.

docs/managing-dragonfly/tiering.md

[qodo-free-for-open-source-projects]

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

_{To customize comments, go to the Qodo configuration screen, or learn more in the docs.}