Skip to content

Add README to /templates directory #1163

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
Merged
merged 3 commits into from
May 5, 2022
Merged

Add README to /templates directory #1163

merged 3 commits into from
May 5, 2022

Conversation

@gfscott
Copy link
Contributor

@gfscott gfscott commented May 2, 2022

Description

This PR adds a README to /templates explaining what Hydrogen templates are, and describing the two we currently/will soon offer. Keeping this as a draft until the Demo Store template migrates in.

Before submitting the PR, please make sure you do the following:

  • Read the Contributing Guidelines
  • Provide a description in this PR that addresses what the PR is solving, or reference the issue that it solves (e.g. fixes #123)
  • Update docs in this repository according to your change
  • Run yarn changeset add if this PR cause a version bump based on Keep a Changelog and adheres to Semantic Versioning

@gfscott gfscott requested a review from a team May 2, 2022 16:12
@gfscott gfscott self-assigned this May 2, 2022
@gfscott gfscott added the documentation Improvements or additions to documentation aka docs label May 2, 2022
jplhomer
jplhomer approved these changes May 2, 2022
View reviewed changes
Copy link
Contributor

@jplhomer jplhomer left a comment

Choose a reason for hiding this comment

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

🚀

@gfscott gfscott requested a review from mcvinci May 2, 2022 18:11
mcvinci
mcvinci approved these changes May 2, 2022
View reviewed changes
Copy link
Contributor

@mcvinci mcvinci left a comment

Choose a reason for hiding this comment

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

Thanks for these updates, @gfscott! After this PR merges, I'm going to make some revisions to our Hydrogen templates topic on Shopify.dev to align accordingly, as well: https://shopify.dev/custom-storefronts/hydrogen/templates

@mcvinci
Copy link
Contributor

mcvinci commented May 3, 2022

@gfscott Related question: Will these commands also be available through yarn, or are they exclusively run through npx?

@gfscott gfscott force-pushed the @gfscott/templates-readme branch from 913f0a7 to c7dda15 Compare May 4, 2022 17:14
@gfscott
Copy link
Contributor Author

gfscott commented May 4, 2022

@mcvinci Good question! I'm reasonably certain this works with npm init, npx and yarn, just like we have in the current getting started docs.

Should we pick a winner in this context, or keep surfacing all options? Do you have any strong views?

@mcvinci
Copy link
Contributor

mcvinci commented May 4, 2022

@gfscott I'd love if we could surface all options! It would keep the information aligned with what we have on Shopify.dev, too. I'd be hesitant to assert a preference here as developers might want to use any one of these options, so I'd suggest airing on the side of comprehensiveness!

@gfscott gfscott marked this pull request as ready for review May 5, 2022 14:15
@gfscott gfscott merged commit 1bd575d into v1.x-2022-07 May 5, 2022
@gfscott gfscott deleted the @gfscott/templates-readme branch May 5, 2022 14:43
blittle added a commit that referenced this pull request May 9, 2022
@blittle
Merge branch 'v1.x-2022-07' into bl-countries-session
c11637f 
* v1.x-2022-07:
  Fix stale product options (#1210)
  Upgrade body-parser in hydrogen package (#1232)
  Add new options to Money and useMoney (#1215)
  fix links (#1229)
  Update turbo and instructions for developing `dev` (#1225)
  Heck - deploy all branches to Oxygen
  add context for initialvariantid (#1217)
  Build chunks are inside assets folder (#1211)
  Upgraded to SFAPI 2022-07 (#1214)
  [ci] release v1.x-2022-07 (#1205)
  Make this a patch instead of minor
  add references to video in file_reference block (#1197)
  Laying the foundation for building components in isolation (#1188)
  Make metafields optional within the ProductProvider. Fixes #1127 (#1209)
  Add README to /templates directory (#1163)
  fix perf tracking and make it optional from developer's end (#1096)
  docs fixes (#1204)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jplhomer jplhomer jplhomer approved these changes

@mcvinci mcvinci mcvinci approved these changes

Assignees

@gfscott gfscott

Labels

documentation Improvements or additions to documentation aka docs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gfscott @mcvinci @jplhomer