Add documentation for clients #161
Comments
|
I'm not sure a list of clients is a good fit for man pages, but it's good material for the website. What we need here is probably website logic to render this content. We can also change the format. Having the URL encoded as a path doesn't seem very practical nor intuitive to people. I'd prefer just a list of clients, where "language" is just one field. (Possibly we could also move these JSON files to the website repo.) |
1 task
madolson
added a commit
to valkey-io/valkey-io.github.io
that referenced
this issue
Mar 3, 2025
### Description Adds a client page to docs on the website. The page is added to the top nav docs, called "Client Libraries", and its url is top level `valkey.io/clients `. This PR is dependent on the [complimentary docs PR](valkey-io/valkey-doc#164) being merged. #### How it works - - The `init-topics.sh` script was modified to expect the path to the clients docs folder as its second argument. It creates a symlink to it, called `build-clients`. The clients folder in docs holds json files specifying each client's details and features. - `content/clients/_index.md` has in its frontmatter the list of paths to the clients appearing in this page. This list is used by the `client-list.html` template to render the specified clients' data. This template also includes the `client-feature-table.html` template that renders the same json files to produce a table comparing which features each client implements. ### Issues Resolved [#161](valkey-io/valkey-doc#161) Dependent on this PR being merged - [#164](valkey-io/valkey-doc#164) ### Check List - [x] 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. --------- Signed-off-by: lior sventitzky <[email protected]> Signed-off-by: Lior Sventitzky <[email protected]> Co-authored-by: Madelyn Olson <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
We still have the full list of old Redis clients documented here: https://github.com/valkey-io/valkey-doc/tree/main/clients but we aren't rendering them on either the website or the man pages. We also want to introduce the list of official clients which have the latest API compatibility and are supported.
For official clients, we want to create a table outlining the the features they support and a link to either the getting started page or their official repository.
The text was updated successfully, but these errors were encountered: