docs: remove grunt and update usage of build scripts #5656
Merged
Conversation
This file contains 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
| <pre>cp sandbox/index.html.example sandbox/index.html</pre> | ||
| <pre>npm run start</pre> | ||
| <pre>open http://localhost:9999/sandbox/index.html</pre> | ||
| <p>You can use /sandbox/ for writing and testing your own code. Nothing in /sandbox/ will get checked into the repo, except files that end in .example (so don't edit or add those files). To get started run `npm start` and open the combined-tracks.html</p> |
There was a problem hiding this comment.
Should this notice be removed from these examples and just be in the index page? Then we just link back there in examples
There was a problem hiding this comment.
I think the idea is if someone is looking at the file directly or opened it by double-clicking, they'd have a better idea of how to get to it via a web server. Might be something we should revisit, though, I don't think I want to do so as part of this PR.
misteroneill
approved these changes
Dec 5, 2018
brandonocasey
approved these changes
Dec 5, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Since grunt was removed in #5592, we should update our docs to stop referring to grunt and to refer to the new ways of doing things. This includes in things like the sandbox examples.
Also, update the top level index.html and the docs with
npm run docs:fix.