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

Make quickstart guide more friendly #82

Closed
2kindsofcs opened this issue Jul 10, 2022 · 1 comment
Closed

Make quickstart guide more friendly #82

2kindsofcs opened this issue Jul 10, 2022 · 1 comment
Labels
documentation 📔 Improvements or additions to documentation enhancement 🌟 New feature or request

Comments

@2kindsofcs
Copy link

What would you like to be added:

  • a full working example of code
  • maybe FAQ

Why is this needed:
I believe the quickstart guide should contain a full working example.
so that newcomers can easily give it a try.

the day before I tried to follow the steps described in yorkie quickstart.
I created a simple file, "index.js", and wrote example code, then ran the file with "node index.js" as I used to run files with node on my local.
it is no surprise that an error popped up.

ReferenceError: self is not defined
    at Object.<anonymous> (/Users/saemi.park/WebstormProjects/yorkie-test/node_modules/yorkie-js-sdk/dist/yorkie-js-sdk.js:32:4)

later the sentence You need an environment that can run JavaScript, such as a browser. rang a bell to me.
if a user can just copy & paste the example code and see it working, it would be more helpful.

@2kindsofcs 2kindsofcs added the enhancement 🌟 New feature or request label Jul 10, 2022
@hackerwins hackerwins transferred this issue from yorkie-team/yorkie Jun 10, 2023
@hackerwins hackerwins added the documentation 📔 Improvements or additions to documentation label Oct 26, 2023
@hackerwins
Copy link
Member

I'm also sympathizing with this issue. And we have several issues similar to this.

So I'll close this issue for now.

later the sentence You need an environment that can run JavaScript, such as a browser. rang a bell to me.
if a user can just copy & paste the example code and see it working, it would be more helpful.

This bug might be fixed by yorkie-team/yorkie-js-sdk#378.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📔 Improvements or additions to documentation enhancement 🌟 New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants