Is your feature request related to a problem? Please describe.
As a developer who does not code daily in NewsKit rep, it would be helpful to provide a list of common commands in the ReadMe.md to allow me to quickly do basic tasks. The package.json file has 72 commands and difficult to know which to run or next steps required.
Describe the solution you'd like
- Document how to run the documentation site locally (with the URL we need to launch in the browser)
- Document how to run specific tests (running all will run out of memory).
- Best practice to implement dark-mode in your app (perhaps a link to the doc site that describes)
- More to come, I'm sure.
Describe alternatives you've considered
Developers who are not day-to-day familiar with NewsKit could store commands in a code snippet manager, but seems unlikely that would be scalable.
Additional context
A Dow Jones developer asked about how to implement dark-mode in the NewsKit way, and I had difficulty finding basic commands to verify I was giving the correct information. Additionally, with a quick start command line documentation, the developer could have self-discovered the answers needed.
Is your feature request related to a problem? Please describe.
As a developer who does not code daily in NewsKit rep, it would be helpful to provide a list of common commands in the ReadMe.md to allow me to quickly do basic tasks. The package.json file has 72 commands and difficult to know which to run or next steps required.
Describe the solution you'd like
Describe alternatives you've considered
Developers who are not day-to-day familiar with NewsKit could store commands in a code snippet manager, but seems unlikely that would be scalable.
Additional context
A Dow Jones developer asked about how to implement dark-mode in the NewsKit way, and I had difficulty finding basic commands to verify I was giving the correct information. Additionally, with a quick start command line documentation, the developer could have self-discovered the answers needed.