PR: Split the Generator Command from Output for Clarity Fixes #6441 #6442

nelsonic · 2025-08-25T21:56:28Z

This PR splits the command from it's output in the docs to fix #6441

Feel free to ignore if you prefer to keep it the way it is ... 👌
I'm sure people can figure it out for themselves, just feels like a unpleasant experience IMO. 🙃

…inners following the context guide. fixes phoenixframework#6441

SteffenDE · 2025-08-26T08:40:35Z

Thank you! I think this is good, but we have more places where this is an issue, so if we change this, I think we should change them all. For example, same page we have mix ecto.migrate with output, but also the same problem in the following guides. I guess another way could be to change ex_doc to only copy lines starting with a shell identifier - if one exists. Let's see what @josevalim thinks :)

josevalim · 2025-08-26T08:56:07Z

Unfortunately, I can also see people wanting to copy the whole contents, so splitting the command and the output looks like a good idea to me

nelsonic · 2025-08-26T09:22:58Z

Gents, I'm happy to go through all the docs and apply these changes for consistency. 👌

SteffenDE · 2025-08-26T09:24:13Z

Very nice, thank you a lot! :)

nelsonic · 2025-08-26T10:19:10Z

Should I apply the changes to this PR or open a separate one? (happy either way, just want to keep it reviewable)

josevalim · 2025-08-26T10:38:22Z

This one! Also feel free to do it as separate commits and we will squash it all at the end automatically.

…onships.md ref: phoenixframework#6442

SteffenDE · 2025-08-29T09:42:17Z

@nelsonic I think we should also do the same for chapter 4 and 5 if you did not already plan to do that.

nelsonic · 2025-08-31T07:01:19Z

@SteffenDE good plan. 🧑‍💻 👌

…ionships.md

…s_context_boundaries.md

…will will" -> "will"

rhcarvalho · 2025-09-23T15:58:32Z

installer/templates/phx_single/AGENTS.md

 - Phoenix v1.8 moved the `<.flash_group>` component to the `Layouts` module. You are **forbidden** from calling `<.flash_group>` outside of the `layouts.ex` module
 - Out of the box, `core_components.ex` imports an `<.icon name="hero-x-mark" class="w-5 h-5"/>` component for for hero icons. **Always** use the `<.icon>` component for icons, **never** use `Heroicons` modules or similar
- **Always** use the imported `<.input>` component for form inputs from `core_components.ex` when available. `<.input>` is imported and using it will will save steps and prevent errors
+- **Always** use the imported `<.input>` component for form inputs from `core_components.ex` when available. `<.input>` is imported and using it will save steps and prevent errors


💡 This and the similar change in usage-rules/phoenix.md could be extracted to a separate PR and merged sooner, as they're simple typo fixes.

Ok. Will split into separate PR when I’m back at my desk tomorrow morning. Thanks.

Separate micro-PR to fix: #6492

rhcarvalho

Some suggestions from an outside contributor who wants to see docs getting better and likes the initiative in this PR :)

rhcarvalho · 2025-09-23T16:02:02Z

guides/data_modelling/in_context_relationships.md


 ```console
-$ mix phx.gen.context Catalog Category categories \
+mix phx.gen.context Catalog Category categories \


In my experience the console "language" is used when there's a prompt like $ , while shell is used for when there's no prompt.

Examples:

$ mix phx.gen.context Catalog Category categories \ title:string:unique --no-scope

mix phx.gen.context Catalog Category categories \ title:string:unique --no-scope

Not much to syntax highlight anyway :)

let's keep the $ for console when it shows a command to run :)

guides/data_modelling/in_context_relationships.md

rhcarvalho · 2025-09-23T16:05:26Z

guides/data_modelling/cross_context_boundaries.md

+Do you want to create a LiveView based authentication system? [Yn]
+```
+
+Type `n` followed by `Return` key,


I wonder if it's worth mentioning the exact keystrokes here. Some keyboards/locales will have enter, some return, maybe others?!

Take your point. 👌
People tend to know the Return key is interchangeable with Enter. 💭
Just being explicit so people know they need to perform that input. ⌨️

rhcarvalho · 2025-09-23T16:07:45Z

guides/data_modelling/in_context_relationships.md

+
+You will see output confirming the migration file was created:

+```console


I think for pure console output blocks we should use no language hint = no syntax highlight (I'm not part of the Phoenix team, though, just an outside contributor :) -- Steffen and other maintainers have the say here).

When there's no language hint, ExDoc uses Elixir, so for just text you want text as language. But console works fine as well. The only thing console does is make the dollar sign at the start of lines non-selectable and ignored when copying.

Suggested change

```console

```text

Will apply this suggestion on localhost. 👌

Co-authored-by: Rodolfo Carvalho <rhcarvalho@gmail.com>

guides/data_modelling/your_first_context.md

rhcarvalho · 2025-09-24T15:51:14Z

@nelsonic I just realized you're behind @dwyl! I need to say thanks for the great content you and team have produced, I benefitted from it in my early journey with Elixir and Phoenix :)
I also love your business/lifestyle explorations! Thanks 💜

Split the generator command from the output to make it easier for beg…

b1b70aa

…inners following the context guide. fixes phoenixframework#6441

This was referenced Aug 25, 2025

What are Phoenix contexts dwyl/learn-phoenix#137

Open

Context Docs Copy Code Block Includes Generator Output #6441

Open

nelsonic and others added 2 commits August 28, 2025 07:02

Merge branch 'phoenixframework:main' into fixes-6441

4f931b7

split commands from output in guides/data_modelling/in_context_relati…

c2fd603

…onships.md ref: phoenixframework#6442

nelsonic added 3 commits September 2, 2025 16:24

tidy console input sections in guides/data_modelling/in_context_relat…

c921117

…ionships.md

continue splitting commands from output in guides/data_modelling/cros…

0f81112

…s_context_boundaries.md

fix duplicate word typo in installer/templates/phx_single/AGENTS.md "…

da288b1

…will will" -> "will"

rhcarvalho reviewed Sep 23, 2025

View reviewed changes

Update guides/data_modelling/in_context_relationships.md

94b33cc

Co-authored-by: Rodolfo Carvalho <rhcarvalho@gmail.com>

SteffenDE reviewed Sep 24, 2025

View reviewed changes

guides/data_modelling/your_first_context.md Outdated Show resolved Hide resolved

Update guides/data_modelling/your_first_context.md

4607399

revert change to AGENTS.md to avoid merge conflicts.

9b3612a


		You will see output confirming the migration file was created:

		```console

Uh oh!

PR: Split the Generator Command from Output for Clarity Fixes #6441 #6442

Are you sure you want to change the base?

PR: Split the Generator Command from Output for Clarity Fixes #6441 #6442

Uh oh!

Conversation

nelsonic commented Aug 25, 2025

Uh oh!

SteffenDE commented Aug 26, 2025

Uh oh!

josevalim commented Aug 26, 2025

Uh oh!

nelsonic commented Aug 26, 2025

Uh oh!

SteffenDE commented Aug 26, 2025

Uh oh!

nelsonic commented Aug 26, 2025

Uh oh!

josevalim commented Aug 26, 2025

Uh oh!

SteffenDE commented Aug 29, 2025

Uh oh!

nelsonic commented Aug 31, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rhcarvalho left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rhcarvalho commented Sep 24, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants