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.

Sign up for GitHub

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

Jump to bottom

[Task] Add minimal example to Client docs #3033

Open
avifenesh opened this issue Jan 31, 2025 · 0 comments
Open

[Task] Add minimal example to Client docs #3033

avifenesh opened this issue Jan 31, 2025 · 0 comments
Labels
docs Documentation good first issue Good for newcomers node Node.js wrapper
Milestone
1.4

Comments

@avifenesh
Copy link
Member

avifenesh commented Jan 31, 2025 •
edited
Loading

Description

Image Image

Currently, our doc not show almost anything.
Since the common usage of classes is with constructor using new, while we use a method of create client, it results in a bit confusing interface.

We should expand a little our doc, so the user can immediately get the next step he should take.
@avifenesh avifenesh added docs Documentation good first issue Good for newcomers node Node.js wrapper labels Jan 31, 2025
@avifenesh avifenesh added this to the 1.4 milestone Jan 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation good first issue Good for newcomers node Node.js wrapper
Projects
Valkey-GLIDE - internal
Status: No status
Milestone
1.4
Development

No branches or pull requests
1 participant
@avifenesh