Skip to content

docs: make installation guide more beginner-friendly - #6187

Merged
Josh-Cena merged 12 commits into
facebook:mainfrom
PatelN123:main
Dec 26, 2021
Merged

Josh-Cena merged 12 commits into
facebook:mainfrom
PatelN123:main

Conversation

@PatelN123

Copy link
Copy Markdown
Contributor

Motivation

When I started out with Docusaurus I had no idea about NPM, yarn or even coding. I feel that although this isn't a very big change, it'll still help the beginners with getting started. I could've really used with this information when I started, so I feel that it'll definitely help others.

Have you read the Contributing Guidelines on pull requests?

Yes

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Dec 24, 2021
@netlify

netlify Bot commented Dec 24, 2021

Copy link
Copy Markdown

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 48a3e61

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61c8441d10c1310008d62c6d

😎 Browse the preview: https://deploy-preview-6187--docusaurus-2.netlify.app

@github-actions

github-actions Bot commented Dec 24, 2021

Copy link
Copy Markdown

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 75
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-6187--docusaurus-2.netlify.app/

@PatelN123

Copy link
Copy Markdown
Contributor Author

I'm not sure why prettier docs keeps throwing an error?

@Josh-Cena Josh-Cena left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm fine to add a few lines of explanation, but the current one may be too long

Comment thread packages/create-docusaurus/templates/shared/docs/intro.md
Comment thread packages/create-docusaurus/templates/shared/docs/intro.md Outdated
Comment thread packages/create-docusaurus/templates/shared/docs/intro.md Outdated
Comment thread packages/create-docusaurus/templates/shared/docs/intro.md Outdated
@Josh-Cena Josh-Cena changed the title Add support for beginners docs: add more beginner-friendly guides in quick start Dec 25, 2021
@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Dec 25, 2021
@PatelN123
PatelN123 requested a review from Josh-Cena December 26, 2021 09:03
@Josh-Cena Josh-Cena changed the title docs: add more beginner-friendly guides in quick start docs: make installation guide more beginner-friendly Dec 26, 2021

@Josh-Cena Josh-Cena left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I'm done with my edits. If you don't have further modifications we'll merge

@PatelN123

Copy link
Copy Markdown
Contributor Author

I've just added Discord to the https://docusaurus.io/docs/installation#problems part of the page.

@Josh-Cena
Josh-Cena merged commit 7fcadd0 into facebook:main Dec 26, 2021
mrizwanashiq pushed a commit to mrizwanashiq/docusaurus that referenced this pull request Jun 25, 2026
* Add support for beginners

* Add files via upload

* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md

* Update intro.md

* Edits

* Edits

* Last nits

* Edit

* Update installation.md

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants