Issue on docs: Local development instructions are missing steps

[rguldener]

Path: /development

The docs say just run npm i -g mintlify and then run mintlify dev. That did not work for me.

After doing the NPM install I ran mintlify dev and it asked me to install Yarn. Not really what I wanted, but there was no way around it, so I did. I then ran mintlify dev again, this time I got:

? yarn must be globally installed. Install yarn? Yes

added 1 package in 830ms
✖ Dependencies were not installed correctly, run
  
      mintlify install
      

So I ran that. It installed another boatload of packages.

Then finally did mintlify dev actually succeed.

I think the docs should mention that yarn is a required dependency (if that is necessary, I would prefer it was not) and the additional command you need to run to install dependencies first.

[andupotorac]

Same here. So frustrating that it can't even get step 1 done right from https://mintlify.com/docs/development...

[andupotorac]

@rguldener can you share the steps you went through to make this work? I tried adding yarn globally but no luck.

npm install -g yarn npm i -g mintlify mintlify dev

[andupotorac]

It seems the mint.json needs to be created manually and added to this folder. Maybe it should be specified during the repo creation. Once added, their example won't work. You need to use the complete example from here: https://mintlify.com/docs/settings/global#view-example-configuration.

But remove the logos, and add a png / SVG for the favicon. Then it will run, it won't display anything in the browser since that stuff needs to be created at future steps.