search

microsoft / playwright.dev

Documentation website for Playwright
https://playwright.dev
Creative Commons Attribution 4.0 International
118 stars 96 forks source link

README.md should include `npm run prepare-java` (etc.) #430

Closed mrienstra closed 2 years ago

mrienstra commented 2 years ago

While trying to contribute, I followed instructions in the README.md:

npm install
SRC_DIR=~/code/playwright npm run roll
npm run start

... But this resulted in dotnet-only docs being served.

In my case, it seemed I needed to run npm run prepare-nodejs in order to see nodejs docs.

Seems like this would be worth mentioning, to help newbies get up and running quickly.

PS: Also tempted to change ~/code/playwright to ~/path/to/playwright or something... 🤔

Self-service

☑ I'd be willing to fix this bug myself.

mxschmitt commented 2 years ago

Yeah setting up the docs locally is not that straightforward. Usually you: npm run roll -> npm run prepare-nodejs -> npm run start e.g.

mrienstra commented 2 years ago

Along the same lines, what about setting the default (shown when a prepare- command has not been run) to nodejs rather than dotnet, as per the website itself (which defaults to showing "Node.js" docs)?

Not immediately obvious to me how to go about changing that.

mxschmitt commented 2 years ago

Done in https://github.com/microsoft/playwright.dev/commit/26dd38bbbc6e3bc463187c731ee7fe01b9d9828a