-
Notifications
You must be signed in to change notification settings - Fork 860
docs: clarify yarn install purpose in README #4629
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
Closed
Subham-KRLX
wants to merge
15
commits into
carbon-design-system:main
from
Subham-KRLX:improve-readme-install-instruction
Closed
Changes from 5 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
2cb6c6a
docs: clarify yarn install purpose in README
Subham-KRLX 0e3346b
docs: add 'Getting Started as a First-Time Contributor' section to RE…
Subham-KRLX 782646e
chore: update gatsby config and dependencies for local development
Subham-KRLX a617525
Merge branch 'main' into improve-readme-install-instruction
Subham-KRLX bd385ab
docs: refine README per maintainer feedback, clarify install instruct…
Subham-KRLX f875638
Merge branch 'main' into improve-readme-install-instruction
tay1orjones 1b2afdd
Merge branch 'main' into improve-readme-install-instruction
Subham-KRLX 49fe452
Merge branch 'main' into improve-readme-install-instruction
Subham-KRLX 6567585
Merge branch 'main' into improve-readme-install-instruction
Subham-KRLX df01bd7
fix(build): Address @carbon/react resolution errors and update webpac…
Subham-KRLX 08ac4d9
Merge branch 'main' into improve-readme-install-instruction
Subham-KRLX c2d8c5f
Merge branch 'main' into improve-readme-install-instruction
Subham-KRLX 8506af9
Merge branch 'main' into improve-readme-install-instruction
Subham-KRLX e60c8c5
Merge branch 'main' into improve-readme-install-instruction
alisonjoseph c4e8997
chore: yarn format
alisonjoseph File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,12 @@ | ||
| TEST | ||
|
|
||
| # Carbon Design System | ||
|
|
||
|  | ||
|
|
||
| This is the [Carbon Design System website](http://www.carbondesignsystem.com). | ||
| It's built using the | ||
| [gatsby-theme-carbon](https://gatsby.carbondesignsystem.com/) with | ||
| [GatsbyJS](https://www.gatsbyjs.org/). | ||
| This is the [Carbon Design System website](http://www.carbondesignsystem.com). | ||
| It's built using the [gatsby-theme-carbon](https://gatsby.carbondesignsystem.com/) with [GatsbyJS](https://www.gatsbyjs.org/). | ||
|
|
||
| ## 📂 Structure | ||
|
|
||
| ``` | ||
| src | ||
| ├── components | ||
| ├── data | ||
|
|
@@ -20,31 +15,25 @@ src | |
| ├── pages | ||
| ├── styles | ||
| ├── util | ||
| ``` | ||
|
|
||
|
|
||
| ## 👩💻 Develop | ||
|
|
||
| - 🤝 [Contribution guidelines](.github/CONTRIBUTING.md) | ||
| - 📚 | ||
| [Content and Markdown guidelines](https://gatsby-theme-carbon.now.sh/components/markdown) | ||
| - 🗺 | ||
| [Navigation guidelines](https://gatsby-theme-carbon.now.sh/guides/navigation/sidebar) | ||
| - 📚 [Content and Markdown guidelines](https://gatsby-theme-carbon.now.sh/components/markdown) | ||
| - 🗺 [Navigation guidelines](https://gatsby-theme-carbon.now.sh/guides/navigation/sidebar) | ||
|
|
||
| - `yarn install` – install dependencies | ||
| - `yarn install` – installs all project dependencies listed in `package.json` | ||
| - `yarn dev` – start the development server | ||
| - `yarn dev:clean` – use this if you have cache issues | ||
| - `lint:js` – lint your JavaScript files | ||
| - `format` - run Prettier | ||
| - `format` – run Prettier | ||
|
|
||
| If you need more detailed information on how to set up your machine to develop | ||
| locally, please take a look at our | ||
| [wiki](https://github.com/carbon-design-system/carbon-website/wiki). | ||
Subham-KRLX marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| If you need more detailed information on how to set up your machine to develop locally, please take a look at our [wiki](https://github.com/carbon-design-system/carbon-website/wiki). | ||
|
|
||
| ## 🚀 Build | ||
|
|
||
| Running the build command generates all the files and places them in the | ||
| `public` folder. | ||
| Running the build command generates all the files and places them in the `public` folder. | ||
|
|
||
| ``` | ||
| yarn build | ||
| ``` | ||
|
Comment on lines
-48
to
-50
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why remove code formatting for this? |
||
|
|
||
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
removing the backtics cause this to not be formatted properly. I'd just leave them in.