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

Add generic web quick start #556

Merged
merged 7 commits into from
Feb 9, 2024
Merged

Add generic web quick start #556

merged 7 commits into from
Feb 9, 2024

Conversation

gewenyu99
Copy link
Contributor

What does this PR do?

Add a generic web quickstart.
/docs/quick-starts/js/

Covers JS basics + Typescript basics.

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

@gewenyu99 gewenyu99 requested a review from TGlide January 26, 2024 22:57
Copy link

render bot commented Jan 26, 2024


{% /section %}
{% section #step-2 step=2 title="Create project" %}
You can install the Appwrite Web SDK using CDN with a script tag.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's not installing, right? Maybe add instead

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with Thomas. Maybe say "One way to use the Appwrite Web SDK is with a CDN link". Or something along those lines.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to add

src/routes/docs/quick-starts/js/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/quick-starts/js/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/quick-starts/js/+page.markdoc Outdated Show resolved Hide resolved
Vincent (Wen Yu) Ge and others added 6 commits February 9, 2024 12:16
Co-authored-by: Thomas G. Lopes <26071571+TGlide@users.noreply.github.com>
Co-authored-by: Thomas G. Lopes <26071571+TGlide@users.noreply.github.com>
Co-authored-by: Thomas G. Lopes <26071571+TGlide@users.noreply.github.com>
Copy link
Contributor

@divanov11 divanov11 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added some suggestions

back: /docs/quick-starts
---

Learn how to add Appwrite to your JavaScript or TypeScript web apps.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This this is for the web I think javascript and typescript support can be assumed. How about: "Learn how to add Appwrite to your web apps."


{% /section %}
{% section #step-2 step=2 title="Create project" %}
You can add the Appwrite Web SDK using CDN with a script tag.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't we encourage people to download the web SDK?

I feel like the CDN option should be secondary, so maybe reposition this below the NPM option?

const client: Client = new Client();

client
.setEndpoint(<>>)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like we have a typo in "setEndpoint"

@gewenyu99 gewenyu99 merged commit bd7292f into main Feb 9, 2024
1 check failed
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 this pull request may close these issues.

3 participants