[FIX] - Adding npm install to contributing.md
#256
Conversation
This file contains 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
dawnkelly09
requested changes
Dec 13, 2024
| cd polkadot-docs && npm install | ||
| ``` | ||
|
|
||
| 3. In the `polkadot-mkdocs` folder, you can build the site by running: | ||
|
|
||
| ```bash | ||
| mkdocs serve |
There was a problem hiding this comment.
Suggested change
| mkdocs serve | |
| cd .. | |
| mkdocs serve |
There was a problem hiding this comment.
Let's get them back to the right folder safely
There was a problem hiding this comment.
Yeah, I considered adding cd .., but I'm a bit unsure about it.
I was worried about misleading users into thinking they can serve the site only if they run cd .. first (which might seem silly, but if it's all together, it could lead to that). WDYT?
There was a problem hiding this comment.
I can see that. Maybe something like "Navigate back to the polkadot-mkdocs folder then build the site...."?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR aims to include the command
npm installin the set of instructions for contributing to polkadot-docs