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.

Sign up for GitHub

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

Jump to bottom

Docs guides #517

Merged
merged 44 commits into from
May 13, 2022
Merged

Docs guides #517

merged 44 commits into from
May 13, 2022

Conversation

elitan
Copy link
Contributor

@elitan elitan commented May 6, 2022 •
edited
Loading

Things I think we should do in follow-up PRs:

  • Remove the "Get started" top menu section and relocate the content there.
  • Reconsider where to put the "Get started with Nhost CLI". It does not feel natural to put it under "Overview".

gdangelo and others added 23 commits April 28, 2022 11:26
@gdangelo
Create "Get started with Nhost CLI" guide
5a06ecb
@gdangelo
Add "Get help" section
b32c1ba
@gdangelo
Rename file to get-started-with-nhost-cli
6749bf3
@gdangelo
Add missing file extension
ed46a7a
@gdangelo
Add content for the Next.js quickstart guide
87fc565
@plmercereau
fix: close img tags
a9bc698
@plmercereau
fix: close img tags
116c8eb
@gdangelo
Update language for syntax highlighting to bash + add titles
b8c0dba
@gdangelo
Use admonitions instead of basic Markdown quotes
cf1518a
@gdangelo
Add title to code snippets + fix syntax highlighting + add tabs + adm…
5cf8ace 
…onitions
@gdangelo
Re-organize sections
92f9576
@gdangelo
Remove sections number + add level 4 titles
396dc55
@gdangelo
Add missing props to NhostApolloProvider
e0e9729
@gdangelo
Add content for the React quickstart guide
776555b
@gdangelo
Use .mdx extension instead
2afa460
@gdangelo
Use .mdx extension instead
c9d474e
@gdangelo
Remove the CLI and Github connection steps
05d25a5 
As discussed with Johan
@gdangelo
Remove the CLI and Github connection steps
1a7007d 
As discussed with Johan.
@gdangelo
Edit code snippets to replace Tailwind utility classes with CSS modules
3e6057b 
As discussed with Johan. The Next.js template for this guide has also been edited to remove Tailwind CSS and use CSS modules instead.

You can find this template here: https://github.com/gdangelo/nhost-quickstart-nextjs. Please make sure to move it to the Nhost Github repository.
@gdangelo
Edit code snippets to replace Tailwind utility classes with CSS modules
c7aa9f7 
As discussed with Johan. The React template for this guide has also been edited to remove Tailwind CSS and use CSS modules instead.

You can find this template here: https://github.com/gdangelo/cra-template-quickstart-nhost. Please make sure to move it to the Nhost Github repository and publish it to npm.
Merge pull request #485 from gdangelo/patch-3
fbc9ff3 
Add content for the Next.js quickstart guide
Merge pull request #484 from gdangelo/patch-2
05e0c42 
Create "Get started with Nhost CLI" guide
Merge pull request #494 from gdangelo/patch-4
50ba5fe 
Add content for the React quickstart guide
@elitan elitan requested a review from guicurcio as a code owner May 6, 2022 10:00
@vercel
Copy link

vercel bot commented May 6, 2022 •
edited
Loading

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

Name Status Preview Updated
docs ✅ Ready (Inspect) Visit Preview May 13, 2022 at 0:21AM (UTC)

@changeset-bot
Copy link

changeset-bot bot commented May 6, 2022 •
edited
Loading

⚠️ No Changeset found

Latest commit: d7aaeeb

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@elitan elitan added the documentation Improvements or additions to documentation label May 6, 2022
@elitan
Copy link
Contributor Author

elitan commented May 9, 2022

I'm marking this PR as a draft because I found issues with the guides when I was going through them.

gdangelo and others added 3 commits May 9, 2022 19:12
@gdangelo
docs: Update Next.js quickstart guide
c82605c
@gdangelo
docs: Update React quickstart guide
c7ce665 
Update the guide based on Johan's feedback + add a new section at the end to show how to use the GraphQL API to fetch user data + reflect changes from the provided template.
Merge pull request #536 from gdangelo/patch-6
8980c99 
docs: Update React quickstart guide
Merge pull request #535 from gdangelo/patch-5
95dbfd5 
docs: Update Next.js quickstart guide
@elitan elitan marked this pull request as ready for review May 12, 2022 06:13
@elitan elitan requested a review from szilarddoro May 12, 2022 07:30
plmercereau
plmercereau suggested changes May 12, 2022
View reviewed changes
Copy link
Contributor

@plmercereau plmercereau left a comment

Choose a reason for hiding this comment

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

good stuff :)

some images are in dark mode, while other are in light more

docs/docs/platform/overview/get-started-with-nhost-cli.md Show resolved Hide resolved
docs/docs/platform/quickstarts/nextjs.mdx Outdated Show resolved Hide resolved
docs/docs/platform/quickstarts/nextjs.mdx Show resolved Hide resolved
docs/docs/platform/quickstarts/nextjs.mdx Outdated Show resolved Hide resolved
docs/docs/platform/quickstarts/react.mdx Outdated Show resolved Hide resolved
@szilarddoro
Copy link
Contributor

I agree with @plmercereau's comments. The rest looks good to me.

@elitan elitan requested a review from plmercereau May 13, 2022 12:21
szilarddoro
szilarddoro approved these changes May 13, 2022
View reviewed changes
Copy link
Contributor

@szilarddoro szilarddoro left a comment

Choose a reason for hiding this comment

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

🚀

@elitan elitan merged commit 0d87c30 into main May 13, 2022
@elitan elitan deleted the docs-guides branch May 13, 2022 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@szilarddoro szilarddoro szilarddoro approved these changes

@plmercereau plmercereau plmercereau approved these changes

@guicurcio guicurcio Awaiting requested review from guicurcio

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@elitan @szilarddoro @plmercereau @gdangelo