Skip to content
This repository has been archived by the owner on Oct 1, 2024. It is now read-only.

Commit

Permalink
Merge pull request #1488 from Shopify/doc-update
Browse files Browse the repository at this point in the history
update manual files removal steps
  • Loading branch information
michenly authored Jun 3, 2020
2 parents b2a2868 + 979a746 commit 720d453
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
2 changes: 1 addition & 1 deletion gems/quilt_rails/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ When prompted, choose `rails`. This will generate a basic Rails application scaf

Alternatively, you can use [`rails new .`](https://guides.rubyonrails.org/command_line.html#rails-new) to do the same.

In either case, remove [`webpacker`](./docs/FAQ.md#i-run-into-webpacker-issue-while-setting-up-quilt_rails) before continuing.
In either case, remove [`webpacker`](./docs/FAQ.md#i-run-into-webpacker-issue-while-setting-up-quilt_rails) and [these files](./docs/FAQ.md#any-other-files-i-should-remove-before-running-generator) that any create conflict before continuing.

#### Add Ruby dependencies

Expand Down
4 changes: 4 additions & 0 deletions gems/quilt_rails/docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,7 @@ useQuery(MyQuery, {
We suggest using webpack or [@shopify/sewing-kit](https://github.com/Shopify/sewing-kit) instead of webpacker with `quilt_rails` for JavaScript build.

Remove webpacker by running `bundle remove webpacker` and remove any webpacker configuration files (`config/webpack` and `config/webpacker.yml`).

### Any other files I should remove before running generator?

Other files that often come with default rails scaffolding that can create conflict with `quilt_rails` setup included `.browserslistrc`, `postcss.config.js`, `babel.config.js` as well as `package.json` and `yarn.lock`.

0 comments on commit 720d453

Please sign in to comment.