Skip to content

chore: cf.reserve docs#540

Open
kostasrim wants to merge 1 commit into
mainfrom
kcuckoo1
Open

chore: cf.reserve docs#540
kostasrim wants to merge 1 commit into
mainfrom
kcuckoo1

Conversation

@kostasrim

Copy link
Copy Markdown
Contributor
  • add cf.reserve docs
  • update cf compat docs

@kostasrim kostasrim self-assigned this Jun 26, 2026
@vercel

vercel Bot commented Jun 26, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview, Comment Jun 26, 2026 2:15pm

Request Review

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Docs: add CF.RESERVE command page and update CF compatibility support
📝 Documentation 🕐 10-20 Minutes

Grey Divider

Description

• Document CF.RESERVE syntax, parameters, and examples for Dragonfly.
• Add a Cuckoo Filter section to the command reference sidebar.
• Update compatibility matrix to reflect supported CF commands, including CF.RESERVE.
Diagram

graph TD
  A["Docusaurus docs site"] --> B["Command reference"] --> C["Cuckoo Filter category"] --> D["CF.RESERVE page"]
  B --> E["Compatibility matrix"] --> F["CF support status"]

  subgraph Legend
    direction LR
    _doc["Doc page"] ~~~ _idx["Index/table"]
  end
Loading
High-Level Assessment

The following are alternative approaches to this PR:

1. Generate compatibility matrix from implementation metadata
  • ➕ Reduces risk of docs drifting from actual command support
  • ➕ Makes future support additions cheaper (single source of truth)
  • ➕ Enables automated validation in CI
  • ➖ Requires adding/maintaining a command registry or annotation system
  • ➖ Adds build/CI complexity for a docs-only concern
2. Adopt a command-doc template/generator for module commands
  • ➕ Ensures consistent sections (syntax/params/return/examples) across commands
  • ➕ Reduces manual formatting errors and missing fields
  • ➖ Upfront work to create templates and migrate existing pages
  • ➖ Less flexibility for commands with unique behaviors

Recommendation: The current approach (hand-authored docs page + explicit compatibility table edits) is appropriate for a small, targeted documentation addition. If CF command coverage expands quickly, consider generating the compatibility matrix (and optionally command pages) from a shared command registry to prevent support-status drift.

Files changed (3) +66 / -9

Documentation (3) +66 / -9
compatibility.mdMark Cuckoo Filter (CF.*) commands as supported in compatibility table +8/-9

Mark Cuckoo Filter (CF.*) commands as supported in compatibility table

• Removes the placeholder Cuckoo Filter row and updates the CF command family naming to "Cuckoo Filter". Changes multiple CF commands (including CF.MEXISTS and CF.RESERVE) from Unsupported to Fully supported in the compatibility matrix.

docs/command-reference/compatibility.md

_category_.ymlAdd Cuckoo Filter category metadata for command reference navigation +4/-0

Add Cuckoo Filter category metadata for command reference navigation

• Introduces a generated-index category entry labeled "Cuckoo Filter" so related command pages are grouped in the sidebar/navigation.

docs/command-reference/cuckoo-filter/category.yml

cf.reserve.mdAdd CF.RESERVE command documentation page +54/-0

Add CF.RESERVE command documentation page

• Documents CF.RESERVE syntax, complexity, ACL category, parameter defaults/ranges, and return types. Adds examples for basic creation, duplicate-key error behavior, and advanced option usage, plus links to related CF command docs.

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

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (1) 📜 Skill insights (0)

Grey Divider


Action required

1. See also links missing pages 📘 Rule violation ☼ Reliability
Description
The new docs/command-reference/cuckoo-filter/cf.reserve.md page links to ./cf.add.md,
./cf.addnx.md, and ./cf.info.md, but those target files are not present in the repo/PR, creating
broken internal links that will 404. This will be surfaced by Docusaurus broken-link checking during
build/link validation and should be fixed to meet documentation build requirements.
Code

docs/command-reference/cuckoo-filter/cf.reserve.md[R52-54]

+## See also
+
+[`CF.ADD`](./cf.add.md) | [`CF.ADDNX`](./cf.addnx.md) | [`CF.INFO`](./cf.info.md)
Evidence
PR Compliance ID 14 requires the Docusaurus build/link validation to succeed without reporting
broken links, and the newly added cf.reserve.md contains a See also section with relative
markdown links to ./cf.add.md, ./cf.addnx.md, and ./cf.info.md. Because those referenced files
are not available in docs/command-reference/cuckoo-filter/ (or elsewhere in the repository) and
are not introduced by this PR, the links will be unresolved and will be flagged by the docs build’s
broken-link checking output during build/publish.

AGENTS.md: Docusaurus Site Build Must Succeed and Be Used to Validate Links and Errors
docs/command-reference/cuckoo-filter/cf.reserve.md[52-54]
docusaurus.config.mjs[14-18]

Agent prompt
The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
`docs/command-reference/cuckoo-filter/cf.reserve.md` includes `See also` internal links that point to non-existent docs pages, producing broken markdown links that will be reported by Docusaurus build/link validation.

## Issue Context
The `See also` section currently references `./cf.add.md`, `./cf.addnx.md`, and `./cf.info.md`, but these files are not present under `docs/command-reference/cuckoo-filter/` (or elsewhere in the repo) and are not added by this PR. Docusaurus is configured to check broken links, so these dead links will surface during build/publish (even if treated as warnings), degrading docs quality and cluttering CI output.

## Fix Focus Areas
- docs/command-reference/cuckoo-filter/cf.reserve.md[52-54]

## Suggested fix
Choose one of:
1) Add the missing docs pages (`cf.add.md`, `cf.addnx.md`, `cf.info.md`) under `docs/command-reference/cuckoo-filter/`, or
2) Update `See also` to point to existing pages/sections, or
3) Remove the `See also` links until those pages exist.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools


Grey Divider

Qodo Logo

Comment on lines +52 to +54
## See also

[`CF.ADD`](./cf.add.md) | [`CF.ADDNX`](./cf.addnx.md) | [`CF.INFO`](./cf.info.md)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Action required

1. see also links missing pages 📘 Rule violation ☼ Reliability

The new docs/command-reference/cuckoo-filter/cf.reserve.md page links to ./cf.add.md,
./cf.addnx.md, and ./cf.info.md, but those target files are not present in the repo/PR, creating
broken internal links that will 404. This will be surfaced by Docusaurus broken-link checking during
build/link validation and should be fixed to meet documentation build requirements.
Agent Prompt
## Issue description
`docs/command-reference/cuckoo-filter/cf.reserve.md` includes `See also` internal links that point to non-existent docs pages, producing broken markdown links that will be reported by Docusaurus build/link validation.

## Issue Context
The `See also` section currently references `./cf.add.md`, `./cf.addnx.md`, and `./cf.info.md`, but these files are not present under `docs/command-reference/cuckoo-filter/` (or elsewhere in the repo) and are not added by this PR. Docusaurus is configured to check broken links, so these dead links will surface during build/publish (even if treated as warnings), degrading docs quality and cluttering CI output.

## Fix Focus Areas
- docs/command-reference/cuckoo-filter/cf.reserve.md[52-54]

## Suggested fix
Choose one of:
1) Add the missing docs pages (`cf.add.md`, `cf.addnx.md`, `cf.info.md`) under `docs/command-reference/cuckoo-filter/`, or
2) Update `See also` to point to existing pages/sections, or
3) Remove the `See also` links until those pages exist.

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Signed-off-by: Kostas Kyrimis <kostas@dragonflydb.io>
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.

1 participant