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

update docs #19

Closed
mathe42 opened this issue Sep 18, 2022 · 4 comments · Fixed by #58
Closed

update docs #19

mathe42 opened this issue Sep 18, 2022 · 4 comments · Fixed by #58

Comments

@mathe42
Copy link
Contributor

mathe42 commented Sep 18, 2022

Update the docs on www.surrealdb.com (combine deno, node, browser into 1 page) also add bun runntime

@oberbeck
Copy link
Contributor

Personally, I like to have documentation close to the source.

From what I can tell, currently, the documentation is in the website's repository. Does someone have an idea/strategy in mind how to proceed?

@VixieTSQ
Copy link

Personally, I like to have documentation close to the source.

From what I can tell, currently, the documentation is in the website's repository. Does someone have an idea/strategy in mind how to proceed?

This is why I love rust... doc comments are awesome! I don't believe there is an equivalent in JS/TS. The next best thing is we should at least have examples inside the README. We can even really just copy&paste from docs on the website. It's better than nothing.

@tobiemh
Copy link
Member

tobiemh commented Sep 19, 2022

Docs on the readme is good 👍 . Obviously docs on the website need to be up-to-date too.

@mathe42
Copy link
Contributor Author

mathe42 commented Sep 19, 2022

Yes we have #23 but I want to leave a statement regarding all docs:

  1. I will work on JSDocs comments
  2. I think here in readme it is enough to add how to install it for browser, deno, node etc. + minimal example and link to docs.

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

Successfully merging a pull request may close this issue.

4 participants