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

doc: add Refine tutorial #350

Merged
merged 22 commits into from
Dec 13, 2023
Merged

Conversation

necatiozmen
Copy link
Contributor

What does this PR do?

This PR adds a tutorial and quick start guide to the website for Refine and Appwrite. It was done with the knowledge of @gewenyu99

Test Plan

I was not able to render Refine icons after adding them the project. I may need a help for this.

Related PRs and Issues

Have you read the Contributing Guidelines on issues?

Yes

Copy link

vercel bot commented Nov 16, 2023

@necatiozmen is attempting to deploy a commit to the appwrite Team on Vercel.

A member of the Team first needs to authorize it.

@gewenyu99
Copy link
Contributor

Let me tag @TorstenDittmann @TGlide to take a look at the icon changes first. I took a quick look and the content structure looks good. I'll try to give it a detailed review soon.

Thank you so much @necatiozmen

@TGlide
Copy link
Contributor

TGlide commented Nov 16, 2023

Hi! The workflow for icons is: stick the SVG in src/icons/svg, then run pnpm run icons:generate.

Copy link
Contributor

Choose a reason for hiding this comment

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

Take a look at Thomas' comments for the icon workflow. Sorry this isn't documented anywhere! First time we're doing an integration here with the new docs.

@necatiozmen
Copy link
Contributor Author

necatiozmen commented Nov 20, 2023

Hi! The workflow for icons is: stick the SVG in src/icons/svg, then run pnpm run icons:generate.

Hi @TGlide,

I've placed the SVG in the src/icons/svg directory and executed the pnpm run icons:generate command. You can see the commit here: 6ea7d1f.

However, I'm still encountering an issue where the Refine SVG isn't appearing on the tutorials page. Interestingly, it displays correctly on both the quick start and home pages.

Copy link

vercel bot commented Nov 23, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
website ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 1, 2023 7:05pm

@gewenyu99
Copy link
Contributor

Screenshot 2023-11-28 at 9 28 35 AM I wonder if this logo looks like it's the right size. Let me check with design.

Copy link
Contributor

@gewenyu99 gewenyu99 left a comment

Choose a reason for hiding this comment

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

Some comments. Let me also provide some updated screenshots and icons.

src/routes/docs/tutorials/refine/step-2/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tutorials/refine/step-2/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tutorials/refine/step-4/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tutorials/refine/step-4/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tutorials/refine/step-4/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tutorials/refine/step-7/+page.markdoc Outdated Show resolved Hide resolved
src/routes/docs/tutorials/refine/step-6/+page.markdoc Outdated Show resolved Hide resolved
@gewenyu99
Copy link
Contributor

brandbird (48)
brandbird (49)

We have some requirements for the displayed pixel size and zoom for modals. Here's the relevant screenshots updated :)

@gewenyu99
Copy link
Contributor

gewenyu99 commented Nov 28, 2023

refine

We added the same padding size for the refine icon as we do all our other icons in the aw-icons library, so they'll match in size :)

@necatiozmen
Copy link
Contributor Author

refine

We added the same padding size for the refine icon as we do all our other icons in the aw-icons library, so they'll match in size :)

Thank you, I updated it and renders properly now.

@gewenyu99
Copy link
Contributor

Hey, I'm gonna merge this into a branch and carry it forward myself. Thank you so much for your help! This is looking great!

@necatiozmen
Copy link
Contributor Author

Hey, I'm gonna merge this into a branch and carry it forward myself. Thank you so much for your help! This is looking great!

Thanks you so much

@gewenyu99
Copy link
Contributor

Screenshot 2023-12-13 at 3 08 26 PM For the record.

@gewenyu99 gewenyu99 merged commit 805884f into appwrite:main Dec 13, 2023
3 checks passed
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants