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

Update README.md #74

Merged
merged 1 commit into from
Feb 15, 2023
Merged

Update README.md #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ let ENV = {
```

**Note:**
- The images like `/ember-logo.png` will need to be in your `public` folder in your addon.
- The images like `/ember-logo.png` will need to be in your `tests/dummy/public` folder in your addon.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- The images like `/ember-logo.png` will need to be in your `tests/dummy/public` folder in your addon.
- The images like `/ember-logo.png` will need to be in your `tests/dummy/public/assets` folder in your addon.

I always have more consistent results if I add an assets folder in public.

Copy link
Contributor

Choose a reason for hiding this comment

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

Hmm, can you clarify the issues you've seen @MelSumner? I was able to put them in public/images/ in an app project:

https://github.com/elwayman02/hella-drunk/tree/master/public/images

I assume building the demo app for an addon should work similarly; what issue led you to need public/assets/ specifically?

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm going to merge this for now because it's strictly an improvement on the current documentation, but I'd still like to hear more context about the need to use assets/. We can make a separate PR to update this if needed once this conversation concludes.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry @elwayman02 I missed this comment entirely. I think it's fine as-is, we can clarify if other folks run into it.

- You can add as many social links as you want in the `social` array. However, remember to add a logo image in your `public` folder for the custom social links with a name matching the `name` field in your link object. If you are using `field-guide-default-template`, the logos for `github` and `twitter` links will be included by the template for you.


Expand Down
Loading