Update README.md for better build

[Innders]

No description provided.

[BigRoy]

Hope you don't mind me asking a stupid question - but what's the difference between build and start here? How does it behave differently?

What I want is to be able to run the docs live as I edit them, which one should I use?

[MustafaJafar]

What I want is to be able to run the docs live as I edit them, which one should I use?

That would be start.

what's the difference between build and start here? How does it behave differently?

• Build: generates the website within the build directory, this would be needed to deploy the website.
• Start: run live from code

[MustafaJafar]

the new steps didn't work on my side.
and I had to do the following:
configuration:

npm install -g yarn  # run once in any place
cd {ayon-doc-repo}/website 
yarn add docusaurus --dev  # run once in website directory

run live from server

cd {ayon-doc-repo}/website 
yarn start

[Innders]

the new steps didn't work on my side.

Fixed. added npm install first. You shouldn't (in this testing) be using yarn.

[johhnry]

@Innders I think here we should choose whether to use NPM or Yarn. In the current main branch, the website directory has both yarn.lock and package-lock.json which is not advised as stated by Yarn:

❯ yarn install                                                                                     
yarn install v1.22.19
warning package-lock.json found.
Your project contains lock files generated by tools other than Yarn.
It is advised not to mix package managers in order to avoid resolution inconsistencies caused by unsynchronized lock files.
To clear this warning, remove package-lock.json.

I tend to use Yarn because Docusaurus was built by Facebook, so the build instructions would be (remove package-lock.json):

$ npm install -g yarn
$ cd website
$ yarn install
$ yarn start

Note: I had build issues when using NPM with package-lock.json

Also note that Yarn can be "enabled" by using Corepack (experimental):

$ corepack enable
$ yarn --version