Skip to content

Remove the unused clients directory - #2

Open
madolson wants to merge 1 commit into
mainfrom
remove-clients-dir
Open

madolson wants to merge 1 commit into
mainfrom
remove-clients-dir

Conversation

@madolson

Copy link
Copy Markdown
Owner

The clients/ directory is no longer read by anything. valkey-io/valkey-io.github.io#602 moved the clients catalog into the website repo, so entries added here never reach valkey.io/clients/, but the README still tells contributors to add them here. This deletes clients/ and points the README at the website's add_library pull request template.

AI generated details

Problem

valkey-io/valkey-io.github.io#602 (merged 2026-10-27, bb34a34c80753c95f493c1713ee2c83a99d3e3b5) builds /clients/ from _data/libraries/clients/ in the website repo. The website deploy reads only topics and commands from this repo:

  • website .github/workflows/zola-deploy.yml:63-64: ./build/init-topics.sh ../valkey-doc/topics and ./build/init-commands.sh ../valkey-doc/commands ...
  • website README.md:48: "The clients and integrations pages (/clients/, /integrations/) are built from _data/libraries/ in this repo, so they need no other repo."

README.md:76-103 here still described clients/{language}/{repository}.json as the way to get listed. Five PRs following it were closed today: valkey-io#399, valkey-io#413, valkey-io#461, valkey-io#506, valkey-io#507.

All 15 JSON entries under clients/ exist in website _data/libraries/clients/, so nothing is lost.

Other consumers checked

None found.

  • This repo: no workflow, Makefile target, or spellcheck config reads clients/. Spellcheck covers topics/*.md and commands/*.md only (.spellcheckerrc.yml:1-4).
  • utils/check-links.pl:24, utils/links-to-man.py:63-64 and utils/preprocess-markdown.py:255 treat ../clients/ as a link to the generated valkey.io page, not to this directory. Five topics use that link (e.g. topics/introduction.md:32), and the website rewrites it to /clients/ (website templates/macros/docs.html:39). Those links stay valid. check-links.pl passes with 0 broken links.
  • Website main: no reference to valkey-doc/clients, build-clients, or init-topics-and-clients.sh in build/, config.toml, templates, workflows, or .gitignore.
  • valkey-io/valkey and valkey-io/valkey-release-automation: no reference to clients/. Debian packaging installs only commands/ and topics/ (packaging/common/debian/valkey-doc.install:2-3).
  • No open PR on this repo touches clients/.

This was generated by AI but verified, with love, by a human.

The clients catalog moved to _data/libraries/clients/ in
valkey-io/valkey-io.github.io (#602), and the website deploy no longer
reads clients/ from this repo. Delete the directory and point the README
at the website's add_library pull request template instead.

Signed-off-by: Madelyn Olson <madelyneolson@gmail.com>
@madolson madolson added the needs-review Staged work waiting on madolson's review label Oct 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs-review Staged work waiting on madolson's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant