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

Proper documentation #117

Open
u-rogel opened this issue Apr 23, 2023 · 5 comments
Open

Proper documentation #117

u-rogel opened this issue Apr 23, 2023 · 5 comments

Comments

@u-rogel
Copy link

u-rogel commented Apr 23, 2023

@atassis thanks for investing so much time in this module!
I just started a new project with RethinkDB and I really enjoy it! I am missing documentation though, so I jump between the official docs and the codebase here.
I would like to write documentation to make it easier to use this module. Would it be something you consider to add?

@atassis
Copy link
Collaborator

atassis commented Apr 24, 2023

Hi there! I am more than glad to hear that someone suggests a help with docs=)
I think the 1st thing to do with this project is to finish the breaking changes description for this
I have done the major part of changes more than 2 years ago, but for many reasons I haven't finished it. I can go deeper about different things but wanna settle a propepr communication between us. If you are truely eager to help- we can continue to chat in redb's slack, for example

@u-rogel
Copy link
Author

u-rogel commented Apr 24, 2023

Quick reply!
Yes, I would like to help. Wrote you on slack.

@u-rogel
Copy link
Author

u-rogel commented May 15, 2023

@atassis haven't heard from you in some time. Can we still work on it?

@atassis
Copy link
Collaborator

atassis commented May 17, 2023

Hi there. We can=)
You can start asking questions

@u-rogel
Copy link
Author

u-rogel commented May 23, 2023

Do we put all documentation on the README.md file?
Since the JS driver is an entry point to the RethinkDB project, should we add some basic query examples?
Also important question, any topic in documentation you think I should start with?

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

2 participants