diff --git a/js/generate.js b/js/generate.js index a4f1be6..2b14aae 100644 --- a/js/generate.js +++ b/js/generate.js @@ -27,7 +27,7 @@ console.log( 'streaming to ' + OUTPUT_FILE ); // Copy image files try { - // TODO: this assumes we only need image from two repos + // TODO: this assumes we only need image from two repos, see https://github.com/phetsims/binder/issues/28 fsExtra.copySync( __dirname + '/../../sun/doc/images', __dirname + '/../doc/images/sun' ); fsExtra.copySync( __dirname + '/../../scenery-phet/images', __dirname + '/../doc/images/scenery-phet' ); } diff --git a/js/getFromSimInMaster.js b/js/getFromSimInMaster.js index f66d23c..41876f8 100644 --- a/js/getFromSimInMaster.js +++ b/js/getFromSimInMaster.js @@ -136,10 +136,10 @@ module.exports = async commandLineSims => { sims: dataBySim }; - // TODO: is this the best place for this? + // TODO: is this the best place for this? see https://github.com/phetsims/binder/issues/28 // write data to a file so that we don't have to run this so often for quick iteration. fs.writeFileSync( __dirname + '/../binderjson.json', JSON.stringify( outputObject, null, 2 ) ); - // TODO: is it weird to return an object that is by sim THEN by component. createHTML should probably take a data struture based on component at the top level. + // TODO: is it weird to return an object that is by sim THEN by component. createHTML should probably take a data struture based on component at the top level. see https://github.com/phetsims/binder/issues/28 return outputObject; }; \ No newline at end of file diff --git a/js/getMarkdownFileAsHTML.js b/js/getMarkdownFileAsHTML.js index a33619e..0829de2 100644 --- a/js/getMarkdownFileAsHTML.js +++ b/js/getMarkdownFileAsHTML.js @@ -25,7 +25,7 @@ module.exports = function( repo, component ) { markdown = marked( m.toString() ); // Use subdirectory for images, so that different directories can have images of the same name - // TODO: This may yield false positives, say if code examples have this same term. + // TODO: This may yield false positives, say if code examples have this same term, see https://github.com/phetsims/binder/issues/28 markdown = markdown.split( '