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

Updated introduction.md #2483

Merged
merged 7 commits into from
Nov 29, 2023
Merged

Updated introduction.md #2483

merged 7 commits into from
Nov 29, 2023

Conversation

anamayfield
Copy link
Contributor

Description of Problem

  1. The current "Prerequisites" section doesn't provide enough guidance for beginners to learn these essential technologies before diving into Vue.js.
  2. After reading the introduction page, readers may be unclear on what to read or do next, potentially leading to a disjointed learning experience.

Proposed Solution

  1. Expand the "Prerequisites" section to include more resources for beginners to learn HTML and CSS.
  2. Add a “Next Steps” section at the end of the introduction page. This section will guide the reader on which document/page to go to next for further learning.

Additional Information

This addition is aimed at improving the navigational flow of the documentation.

Improved clarity in Prerequisites section and added relevant links.
Added Next Steps section to end of document
@netlify
Copy link

netlify bot commented Aug 16, 2023

Deploy Preview for vuejs ready!

Name Link
🔨 Latest commit 8e1b0a7
🔍 Latest deploy log https://app.netlify.com/sites/vuejs/deploys/656773c1efd31900088ef20f
😎 Deploy Preview https://deploy-preview-2483--vuejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@bencodezen
Copy link
Member

bencodezen commented Aug 16, 2023

Thanks for the PR @anamayfield!

I've left some comments in the PR for you. Let me know if you have any questions.

@bencodezen bencodezen self-requested a review August 16, 2023 18:27
@bencodezen bencodezen self-assigned this Aug 16, 2023
@bencodezen bencodezen added the state: awaiting-feedback Needs more input before further actions can be taken label Aug 16, 2023
src/guide/introduction.md Outdated Show resolved Hide resolved
src/guide/introduction.md Outdated Show resolved Hide resolved
@bencodezen
Copy link
Member

@anamayfield Thanks again for the PR. I've made some changes to the PR to reduce duplication of information so we can go ahead and ship this to everyone. If you have any other suggestions, please feel free to open a new issue so we can talk about it there. Thanks!

@bencodezen bencodezen merged commit 2fbe449 into vuejs:main Nov 29, 2023
1 check passed
nazarepiedady pushed a commit to nazarepiedady/vue3-docs that referenced this pull request Nov 30, 2023
* Update introduction.md

Improved clarity in Prerequisites section and added relevant links.

* Update introduction.md

Added Next Steps section to end of document

* docs: Update src/guide/introduction.md

* docs: remove duplicate section on next steps

* style: remove extra new space

---------

Co-authored-by: Ben Hong <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
state: awaiting-feedback Needs more input before further actions can be taken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants