learn-co-curriculum / react-hooks-npm-lab

Other
4 stars 6.19k forks source link

"We can set up" did not jump out at me as an instruction to edit 'scripts' #12

Closed brigj1 closed 2 years ago

brigj1 commented 2 years ago

Canvas Link

https://learning.flatironschool.com/courses/5186/assignments/179983?module_item_id=397437

Concern

With this instruction:

Run 'npm start' to run this script

you are ok with poking any readers who were not alert to your guidance about adding '"start": "serve"' to the 'scripts' property, right?

That is, to me, the passive reader, I did not perceive the guidance to manually edit 'package.json'. I thought "using the serve package" was sufficient per: This serve (Links to an external site.) package will run a lightweight server. We can set up another npm script to run the server using the serve package:

Additional Context

No response

Suggested Changes

Maybe this was magical thinking on my part, and it's good to poke me into a more active reading stance re your instructions. Otherwise, if you intend a more gentle tour through package setup and usage, maybe make it explicit that you expect the reader to do something: We can set up another npm script to run the server using the serve package:

"We can" is not as clear as something like: You should set up another npm script to run the server using the serve package by updating the scripts property: