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

guides: Introduction section review #4499

Merged
merged 5 commits into from
Oct 1, 2021

Conversation

milmazz
Copy link
Contributor

@milmazz milmazz commented Sep 25, 2021

This PR fixes a few things in the "Introduction" guides:

  • Add the Authentication item to the Overview page to match the listed sections in the sidebar

image

  • Replace the Channels group section with Real-Time, to match the Overview list description.

image

  • Replace the "Introduction" title to be "Channels", which is located under the "Real-Time" section

image

  • Remove the un-existent output Webpack is watching the files from the "Up and Running" page.

@@ -1,4 +1,4 @@
# Introduction
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Should I update the file path from guides/channels/channels.md to be something like guides/real-time/channels.md? Just to follow the pattern described in the sidebar.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would do so. As it's easier to find presence.md then.
But wait for some of the maintainers to approve this oppinion.

@milmazz milmazz changed the title Introduction guides review guides: Introduction section review Sep 25, 2021
@josevalim josevalim merged commit 3d08154 into phoenixframework:master Oct 1, 2021
@josevalim
Copy link
Member

💚 💙 💜 💛 ❤️

@josevalim
Copy link
Member

Feel free to send a PR to rename the directory too!

milmazz added a commit to milmazz/phoenix that referenced this pull request Oct 1, 2021
The proposal to rename the directory comes from this
[comment](phoenixframework#4499 (comment))
josevalim pushed a commit that referenced this pull request Oct 5, 2021
The proposal to rename the directory comes from this
[comment](#4499 (comment))
chrismccord pushed a commit that referenced this pull request Oct 8, 2021
chrismccord pushed a commit that referenced this pull request Oct 8, 2021
The proposal to rename the directory comes from this
[comment](#4499 (comment))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants