-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
Assets documentation #2418
Assets documentation #2418
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great. Only have some small nits :)
guides/assets/asset-management.md
Outdated
`app/assets` tree. | ||
- Manifests (the `all.css`, `all.js`, and `application.js` files in your | ||
project's `assets` trees) requires your app's external libraries or custom | ||
assets – including any any files or directories you add deeper in the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
any any
guides/assets/asset-management.md
Outdated
|
||
``` | ||
app|vendor | ||
|-- assets |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this very picky, but could we use box drawing characters here? 😄
app|vendor
└─ assets
├─ images
│ └─ spree
│ ├─ frontend
│ └─ backend
├─ javascripts
│ └─ spree
│ ├─ frontend
│ └─ backend
└─ stylesheets
└─ spree
├─ frontend
└─ backend
guides/assets/asset-management.md
Outdated
| |-- all.css | ||
|-- backend | ||
|-- all.css | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
vendor
└─ assets
├─ javascripts
│ └─ spree
│ ├─ frontend
│ │ └─ all.js
│ └─ backend
│ └─ all.js
└─ stylesheets
└─ spree
├─ frontend
│ └─ all.css
└─ backend
└─ all.css
I ❤️ box drawing characters
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❤️ Agreed
`spree/frontend` or `spree/backend` subdirectories to avoid conflicts or | ||
accidental file overrides. | ||
|
||
For example, if you want to use the [Foundation CSS framework][foundation] in |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing link
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added this at the bottom of the section. Thank you.
I fixed a typo, added a missing link, and now use box drawing characters for tree diagrams.
@tvdeyen Hey, I updated the asset management guide per your review. When you have a chance could you re-review? |
I’ve rewritten and expanded the documentation about assets in Solidus. I also split it into two articles.
The changes aren't incredibly significant, but here's a summary:
frontend
andbackend
so nothing conflicts and how we don't really recommend overriding in the long term.solidus_frontend
andsolidus_backend
).In the future, I'd like to see more information about Solidus's asset manifests added.
This is part a larger project to improve Solidus's documentation. See this gist with the high-level table of contents. Where and how this documentation will exist is still up for discussion.