search

valkey-io / valkey-doc

Content for website and man pages
Other
23 stars 37 forks source link

Add documentation for clients #161

Open madolson opened 3 months ago

madolson commented 3 months ago

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 commented 3 months ago

@madolson ,

I created a draft PR to initiate the discussion. Please see https://github.com/valkey-io/valkey-doc/pull/164

zuiderkwast commented 2 months ago

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