Add npm script documentation #819
Draft
lilyhuang-github wants to merge 2 commits intoDevelopingSpace:mainfrom
Draft
Add npm script documentation #819lilyhuang-github wants to merge 2 commits intoDevelopingSpace:mainfrom
lilyhuang-github wants to merge 2 commits intoDevelopingSpace:mainfrom
Conversation
Member
|
You can use closing keywords ( |
lilyhuang-github
changed the title
lilyhuang-github
changed the title
lilyhuang-github
force-pushed
the
documentScripts
branch
from
deec1fe to
4aaa401
Compare
Member
|
@lilyhuang-github I found some useful info on a few scripts for testing in the wiki. There's probably more, but it'll be nice to consolidate it all in one place. https://github.com/DevelopingSpace/starchart/wiki/Playwright#running-using-scripts |
Member
|
I also think we should migrate some info out of the wiki into the docs. Instructions on running tests should definitely be included in CONTRIBUTING.md. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is just a start to adding documentation to the npm scripts. It could be changed.
The formatting could definitely be changed and stuff since a lot of the npm scripts runs other npm scripts so I'm not sure how that should be formatted.
Like if it should re explain the script or just link to that script.
And also if it should explain a bit of a wider context on what the script does or the verbosity.
Closes #814