search

DiceDB / dice

DiceDB is a redis-compliant, reactive, scalable, highly-available, unified cache optimized for modern hardware.
https://dicedb.io/
Other
6.88k stars 1.09k forks source link

Docs: Improve HTTP and Websocket documentation #1113

Closed JyotinderSingh closed 1 month ago

JyotinderSingh commented 1 month ago

The HTTP and WebSocket documentation on dicedb.io needs to include some example curl requests to make it easier for users to follow along and try these features.

The documentation page should include corresponding curl requests for each of the examples. Also specify the expected output of each of these commands to these curl requests.

JP-sDEV commented 1 month ago

Hi @JyotinderSingh, could I be assigned this issue?

JyotinderSingh commented 1 month ago

Hi @JyotinderSingh, could I be assigned this issue?

It looks like @vanshavenger already raised a PR for this. So I am assigning it accordingly.

@vanshavenger, thanks a lot for the PR. However, it is always a good practice to comment on an issue first and wait for it to be assigned to you before beginning to work on it. This can prevent duplicate work from being done by more people.

vanshavenger commented 1 month ago

@JyotinderSingh sure, my bad. I saw the issue and started working on it.

@JP-sDEV If you want you can do the changes in the WebSocket Docs. I have made changes in the HTTP Docs

JP-sDEV commented 1 month ago

@vanshavenger sounds good, thanks! Will review your PR to follow your doc styling.