mintlify/docs

Issue on docs: Local development instructions are missing steps

rguldener opened this issue · 3 comments

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.