Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation for clients #161

Open
madolson opened this issue Aug 7, 2024 · 2 comments
Open

Add documentation for clients #161

madolson opened this issue Aug 7, 2024 · 2 comments

Comments

@madolson
Copy link
Member

madolson commented Aug 7, 2024

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.

@asafpamzn
Copy link

@madolson ,

I created a draft PR to initiate the discussion.
Please see #164

@zuiderkwast
Copy link
Contributor

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.)

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

No branches or pull requests

3 participants