Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: remove grunt and update usage of build scripts #5656

Merged
merged 6 commits into from Dec 5, 2018
Merged

Conversation

gkatsev
Copy link
Member

@gkatsev gkatsev commented Dec 5, 2018

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.

<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>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this notice be removed from these examples and just be in the index page? Then we just link back there in examples

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@gkatsev gkatsev merged commit 62f9e78 into master Dec 5, 2018
@gkatsev gkatsev deleted the grunt-docs branch December 5, 2018 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants