Skip to content

Add valkey-large-object command support - #764

Draft
kevinmcgehee wants to merge 1 commit into
valkey-io:mainfrom
kevinmcgehee:largeobject-docs
Draft

kevinmcgehee wants to merge 1 commit into
valkey-io:mainfrom
kevinmcgehee:largeobject-docs

Conversation

@kevinmcgehee

Copy link
Copy Markdown

Draft: do not merge yet. This PR depends on valkey-io/valkey-large-object#197. See Dependencies and merge order.

Description

Add the valkey-large-object module to the documentation site, in the same way as valkey-bloom, valkey-json and valkey-search:

  • Command JSON: build/init-commands.sh takes a sixth argument, the module's src/commands directory, and links it as build-large-object-command-json. config.toml gets command_large_object_json_path, and the command page, the command index and the docs menu read command metadata from it. The CI build action (.github/actions/build-site/action.yml) checks out valkey-io/valkey-large-object and passes the new argument.
  • Command pages: a BLOB.* page shows the "Module: valkey-large-object" row, like the other modules.
  • Version notice: a module entry in valkey-doc's modules.json can have a version_notice text and a command_prefix. The command page shows that text before Usage on the module's command pages. The template has no module-specific text. Only valkey-large-object uses it now: "valkey-large-object is at version 0.x. Commands, arguments, replies, and configuration can change before version 1.0."
  • Docs menu: the module's modules-nav/valkey-large-object.yml (from valkey-doc) adds a "Large object" section with a module badge.
  • README.md and .gitignore are updated for the new argument and link.

Dependencies and merge order

  1. docs: add getting started and command reference valkey-large-object#197 adds src/commands/blob.*.json. init-commands.sh stops if the sixth directory does not exist, so the CI build of this PR needs those files on the module's default branch.
  2. This PR.
  3. Document the valkey-large-object module valkey-doc#552 adds the BLOB.* command pages, the topic pages, the modules.json entry and the modules-nav/ file. If Remove intro paragraph above demo video #552 merges before this PR is live, its command pages show "ERROR. Command JSON Not loaded."

Testing

Built locally with Zola 0.23.6, with valkey-doc from #552 and the command JSON from #197:

  • /commands/ shows the "Large object" group with the six commands.
  • /commands/blob.tcp_set/ shows the version notice before Usage, the Reply section, and the Module row, with no "Command JSON Not loaded".
  • The docs menu has the "Large object" section with the module badge, and the breadcrumb is Topics > Large object > BLOB.TCP_SET.
  • /commands/bf.add/ and the other module and core command pages show no notice.
  • No broken internal links or anchors on the large-object pages.

Issues Resolved

None.

Check List

  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the BSD-3-Clause License.

Read the BLOB.* command JSON files from valkey-io/valkey-large-object,
show the module name on its command pages, and add its menu file from
valkey-doc modules-nav/ to the documentation menu with a module badge.

Show the version notice from modules.json before the usage of commands
of modules that have one.

Signed-off-by: Kevin McGehee <mcgehee@amazon.com>
@coderabbitai

coderabbitai Bot commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Important

Draft PR not reviewed

Draft PRs are not automatically reviewed by default.

  • Trigger a manual review

To automatically review draft PRs, update your CodeRabbit configuration:

reviews:
  auto_review:
    drafts: true
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

This branch has not been deployed

No deployments
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