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

document build.js #396

Merged
2 commits merged into from
Dec 1, 2015
Merged

document build.js #396

2 commits merged into from
Dec 1, 2015

Conversation

ghost
Copy link

@ghost ghost commented Nov 30, 2015

this is something that i've been wanting to do for a longer time now. let's document the quite complicated (for a metalsmith build script at least) build.js file.

i've started and added some base comments. if any of those are wrong or superfluous, please let me know. also let me know if there's something left to be documented!

@ghost
Copy link
Author

ghost commented Nov 30, 2015

ping @nodejs/website

@Fishrock123
Copy link
Contributor

I think most of that was written between @fhemberger and @phillipj so they are probably best to review.

@stevemao
Copy link
Contributor

👍 for comments!!!


'use strict'

// BUILD.JS: This file is responsible for building the HTML site and serving it
// as a static server.
Copy link
Member

Choose a reason for hiding this comment

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

"This file is responsible for building static HTML pages and a server for local development."?

@phillipj
Copy link
Member

phillipj commented Dec 1, 2015

Very nice work @sup! The setup isn't very self explanatory for new comers, hopefully these comments will make it a lot easier too grasp 👍

Other than the comments, this LGTM.

This pull request was closed.
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.

3 participants