Mention milligram in the guides #4570
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
H12
commented
Oct 29, 2021
| @@ -129,6 +129,8 @@ The `assets` directory contains source files related to front-end assets, such a | |||
|
|
|||
| Your other static assets are placed in the `priv/static` folder, where `priv/static/assets` is kept for generated assets. Everything in `priv/static` is served by the `Plug.Static` plug configured in `lib/hello_web/endpoint.ex`. When running in dev mode (`MIX_ENV=dev`), Phoenix watches for any changes you make in the `assets` directory, and then takes care of updating your front end application in your browser as you work. | |||
|
|
|||
| **NB:** When you first create your Phoenix app using `mix phx.new` it is possible to specify options that will affect the presence and layout of the `assets` directory. In fact, Phoenix apps can bring their own front end tools or not have a front-end at all (handy if you're writing an API for example). For more information you can run `mix help phx.new` or see the documentation in [Mix tasks](mix_tasks.html). | |||
| Note that when you first create your Phoenix app using `mix phx.new` it is possible to specify options that will affect the presence and layout of the `assets` directory. In fact, Phoenix apps can bring their own front end tools or not have a front-end at all (handy if you're writing an API for example). For more information you can run `mix help phx.new` or see the documentation in [Mix tasks](mix_tasks.html). | |||
There was a problem hiding this comment.
This is an extremely minor change that is outside the scope of this PR.
I added it because until reading this paragraph I had never seen the acronym "NB" before and had to google it, which slightly increased my friction when reading these docs.
josevalim
reviewed
Oct 29, 2021
|
💚 💙 💜 💛 ❤️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The fact that Phoenix ships with Milligram by default is presently not mentioned anywhere in the guides:
https://github.com/phoenixframework/phoenix/search?q=milligram+path%3Aguides
This PR is meant to address this by giving Milligram a quick mention early-on in the official guides.