Update docs build instruction #235
Closed
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
BigRoy
reviewed
Oct 8, 2024
There was a problem hiding this comment.
For what it's worth - I preferred the old instructions. To the point, and simple command line stuff I could almost directly copy paste into my terminal. Now I need to search through a lot of text to see what I should do and copy each line individually.
I'd rather keep the old command line instruction - and maybe ONLY add this below it as 'explanation'.
| - `yarn add docusaurus --dev` | ||
| - `cd {ayon-doc-repo}/website` | ||
| - `yarn start` | ||
| - Download and install Node.js from [nodejs.org](https://nodejs.org/en/download). |
There was a problem hiding this comment.
Suggested change
| - Download and install Node.js from [nodejs.org](https://nodejs.org/en/download). | |
| - Download and install [Node.js](https://nodejs.org/en/download). |
Would this suffice too?
Innders
reviewed
Oct 8, 2024
|
Thank you for your feedback. |
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.
Changelog Description
Update Docs instructions.
resolve #234
This PR was inspired by #223
Testing notes:
follow the building instructions in the PR and confirm it works.