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

Replace Grunt with npm scripts, and rewrite mkdoc.py in JS #218

Open
kirsle opened this issue Mar 10, 2017 · 0 comments
Open

Replace Grunt with npm scripts, and rewrite mkdoc.py in JS #218

kirsle opened this issue Mar 10, 2017 · 0 comments

Comments

@kirsle
Copy link
Member

kirsle commented Mar 10, 2017

Relevant reading: Why I Left Gulp and Grunt for npm Scripts

I'd like to be able to drop Grunt as a dev dependency and just use simple npm scripts for all the jobs that Grunt currently is doing (build, minify, unit tests, etc.)

Furthermore, the documentation generator tool, mkdoc.py is written in Python to render the Markdown and HTML files in the docs/ folder. This should be re-written in JavaScript so that other contributors can be expected to rebuild the docs when they change the source files in their pull requests.

While I'm at it, the mkdoc.py should not generate documentation for private functions in the docs/rivescript.md output file. Even though I tell developers not to call the private functions, they do anyway, and their visibility in the public documentation is probably to blame for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant