Lengthen 12 command reference descriptions under the 50-char a14y minimum

[worldsoup]

Summary

Follow-up to #546. Re-audited https://www.dragonflydb.io/docs after that PR merged (score 68 → 74) and found 13 pages still failing html.meta-description — 12 real pages plus /docs/search (out of scope, Docusaurus's built-in search page).

These 12 weren't caught by #546's pass because they already had a description frontmatter field — just under a14y's 50-character minimum (18–47 chars). Lengthened all 12 to be genuinely more descriptive, and fixed ACL GENPASS's description along the way, which turned out to be copy-pasted from ACL DRYRUN ("Simulate execution of a command from a user") and didn't describe what GENPASS actually does (generate a password).

Test plan

• yarn build succeeds
• Verified in the build output that all 12 pages' meta descriptions render with the new, longer content

🤖 Generated with Claude Code

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
documentation	Ready	Preview, Comment	Jul 10, 2026 8:34pm

[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

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

PR Summary by Qodo

Expand command doc meta descriptions to meet a11y minimums (and fix ACL GENPASS)

📝 Documentation 🕐 10-20 Minutes

AI Description

• Lengthen 12 command reference description frontmatter values to meet a14y 50+ character checks.
• Fix ACL GENPASS meta description content to accurately describe password generation.
• Improve clarity of rendered HTML meta descriptions in the Docusaurus build output.

Diagram

graph TD
  A["Command reference pages"] --> B["Frontmatter description"] --> C["Docusaurus build"] --> D["HTML meta description"] --> E["a14y audit"]
  subgraph Legend
    direction LR
    _doc["Doc page"] ~~~ _meta["Meta text"] ~~~ _tool["Tool/check"]
  end

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Add a docs lint/CI check for meta description length

• ➕ Prevents regressions (new/edited pages failing the 50-char rule) before merge
• ➕ Provides a single source of truth for minimum length requirements
• ➖ Requires custom scripting or integrating an existing linter into CI
• ➖ May introduce maintenance overhead if rules change

2. Centralize description generation (fallback/template) for command docs

• ➕ Reduces per-page authoring burden and inconsistency
• ➕ Guarantees a baseline length/structure across the command reference
• ➖ Risk of generic, less-informative descriptions
• ➖ May be awkward for commands whose purpose doesn’t fit a template

Recommendation: The PR’s approach (editing frontmatter descriptions in-place) is the fastest and safest fix for the current failures, especially since the issue is content quality/length. If a14y compliance is a recurring concern, consider adding a lightweight CI lint that flags meta descriptions under the threshold to prevent future drift.

Files changed (12) +12 / -12

Documentation (12) +12 / -12

cat.mdExpand ACL CAT meta description +1/-1

Expand ACL CAT meta description

• Replaces a short frontmatter description with a longer, more specific summary of what ACL CAT outputs (categories and commands). This helps meet a14y minimum meta-description length requirements.

docs/command-reference/acl/cat.md

dryrun.mdExpand ACL DRYRUN meta description +1/-1

Expand ACL DRYRUN meta description

• Updates the frontmatter description to explicitly describe permission-check simulation without executing the command. Ensures the rendered meta description is both longer and clearer.

docs/command-reference/acl/dryrun.md

genpass.mdFix and expand ACL GENPASS meta description +1/-1

Fix and expand ACL GENPASS meta description

• Corrects the description content (was incorrectly copied from ACL DRYRUN) and expands it to accurately describe password generation for ACL users. Also brings the text above the a14y minimum length.

docs/command-reference/acl/genpass.md

getuser.mdExpand ACL GETUSER meta description +1/-1

Expand ACL GETUSER meta description

• Improves the description to clearly state it prints ACL rules/permissions for a specified user. Extends the text to satisfy the meta-description length requirement.

docs/command-reference/acl/getuser.md

load.mdExpand ACL LOAD meta description +1/-1

Expand ACL LOAD meta description

• Rephrases and lengthens the description to clarify it reloads ACL rules from the ACL file, replacing current configuration. Targets compliance with the a14y minimum character requirement.

docs/command-reference/acl/load.md

log.mdExpand ACL LOG meta description +1/-1

Expand ACL LOG meta description

• Expands the description to mention security events (e.g., failed authentication attempts) included in ACL logs. Produces a more descriptive meta description for the built site.

docs/command-reference/acl/log.md

save.mdExpand ACL SAVE meta description +1/-1

Expand ACL SAVE meta description

• Updates the frontmatter description to more clearly describe persisting current ACL rules to the ACL file. Lengthens the text to pass the a14y meta description check.

docs/command-reference/acl/save.md

users.mdExpand ACL USERS meta description +1/-1

Expand ACL USERS meta description

• Clarifies that the command lists all ACL usernames defined on the instance and expands the text to meet the minimum meta-description length.

docs/command-reference/acl/users.md

dflycluster-flushslots.mdExpand DFLYCLUSTER FLUSHSLOTS meta description +1/-1

Expand DFLYCLUSTER FLUSHSLOTS meta description

• Lengthens the description to specify deleting keys for a range of hash slots on the current cluster node. Improves specificity and meets a14y length rules.

docs/command-reference/cluster-management/dflycluster-flushslots.md

dflycluster-getslotinfo.mdExpand DFLYCLUSTER GETSLOTINFO meta description +1/-1

Expand DFLYCLUSTER GETSLOTINFO meta description

• Updates the description to mention key counts/metadata for specific hash slots on the current node. Ensures the meta description is sufficiently descriptive and long enough.

docs/command-reference/cluster-management/dflycluster-getslotinfo.md

dflycluster-slot-migration-status.mdExpand slot migration status meta description +1/-1

Expand slot migration status meta description

• Rewrites the frontmatter description to emphasize checking an in-progress hash slot migration status on a cluster node. Extends the text to pass the a14y minimum length threshold.

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

rename.mdExpand RENAME command meta description +1/-1

Expand RENAME command meta description

• Rephrases the description to be more direct about renaming an existing key to a new name in Dragonfly (Redis-compatible). Also lengthens it to satisfy the a14y meta description requirement.

docs/command-reference/generic/rename.md