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

Make documentation clearer and fix invalid links #2717

Merged
merged 14 commits into from
May 3, 2018
Merged
Prev Previous commit
Next Next commit
Tweak assets documentation content
  • Loading branch information
benjaminwil committed Apr 30, 2018
commit e69396e5a5ddcfa2a663c1b79b51b3ceb45a6609
15 changes: 9 additions & 6 deletions guides/assets/override-solidus-assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,21 @@ assets and views.
The custom assets you create for a Solidus extension or the frontend and backend
of a store would not be automatically included and served to clients. For more
information about adding your own custom assets to Solidus, see the
[Asset management](asset-management.md#managing-application-assets) article.
[Asset management][asset-management] article.

This article provides an overview of how Solidus manages assets. Note that it
assumes that you are using the `solidus_frontend` and `solidus_backend` gems
that are included as part of a typical Solidus installation.

[asset-management]: asset-management.md#managing-application-assets

## Overrides and upgrading Solidus

We recommend overriding assets as little as possible. This makes maintaining
your application simpler in the long term. The `solidus_frontend` and
`solidus_backend` gems change with each version, and overrides for one version
might not be effective for the next.
We recommend overriding assets as little as possible. Overriding assets makes
maintaining your application more complicated in the long term.

The `solidus_frontend` and `solidus_backend` gems change with each version, and
overrides for one version might not be effective for the next.

## Override individual CSS or JavaScript definitions

Expand Down Expand Up @@ -57,7 +60,7 @@ footer#footer {
### JavaScript

Just like you can override a single CSS definition being provided by a gem, you
can rewrite an existing JavaScipt function..
can rewrite an existing JavaScript function.

For example, if you wanted to override the `Spree.showVariantImages` method from
`solidus_frontend`'s [`product.js`][product-js], you can do so from any
Expand Down