From eaf5140109a41acd57f5466d3188c89b5ddaedda Mon Sep 17 00:00:00 2001 From: muji Date: Wed, 3 Aug 2016 10:06:30 +0800 Subject: [PATCH] Remove roadmap document. --- README.md | 4 +- doc/API.md | 3 +- doc/COMPILER.md | 4 +- doc/DEVELOPER.md | 3 +- doc/INTRO.md | 2 +- doc/OPTIONS.md | 3 +- doc/ROADMAP.md | 134 ----------------------------------------- doc/readme.md | 2 - doc/roadmap/roadmap.md | 79 ------------------------ mkdoc.js | 9 --- 10 files changed, 11 insertions(+), 232 deletions(-) delete mode 100644 doc/ROADMAP.md delete mode 100644 doc/roadmap/roadmap.md diff --git a/README.md b/README.md index 716d7e50..85490127 100644 --- a/README.md +++ b/README.md @@ -534,8 +534,6 @@ An example for [skatejs][] is in [skate-component](https://github.com/tmpfs/truc For the API docs see [API](https://github.com/tmpfs/trucks/blob/master/doc/API.md), an overview of the available options is in [OPTIONS](https://github.com/tmpfs/trucks/blob/master/doc/OPTIONS.md). For insights into the compiler phases and data structures see [COMPILER](https://github.com/tmpfs/trucks/blob/master/doc/COMPILER.md). -The [ROADMAP](https://github.com/tmpfs/trucks/blob/master/doc/ROADMAP.md) has some ideas for future features. - Information on how to build this project is in [DEVELOPER](https://github.com/tmpfs/trucks/blob/master/doc/DEVELOPER.md). ## License @@ -544,7 +542,7 @@ MIT --- -Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 +Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 3, 2016 [trucks]: https://github.com/tmpfs/trucks [trucks-cli]: https://github.com/tmpfs/trucks/blob/master/packages/trucks-cli diff --git a/doc/API.md b/doc/API.md index d25b0a1e..9a1f56a8 100644 --- a/doc/API.md +++ b/doc/API.md @@ -182,7 +182,7 @@ Creates a component node. --- -Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 +Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 3, 2016 [trucks]: https://github.com/tmpfs/trucks [trucks-cli]: https://github.com/tmpfs/trucks/blob/master/packages/trucks-cli @@ -213,6 +213,7 @@ Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 [write]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-write [transform-csp]: https://github.com/tmpfs/trucks/blob/master/packages/transform-csp [bundle]: https://github.com/tmpfs/trucks/blob/master/packages/transform-bundle +[copy]: https://github.com/tmpfs/trucks/blob/master/packages/transform-copy [skate]: https://github.com/tmpfs/trucks/blob/master/packages/transform-skate [stylus]: https://github.com/tmpfs/trucks/blob/master/packages/transform-stylus [less]: https://github.com/tmpfs/trucks/blob/master/packages/transform-less diff --git a/doc/COMPILER.md b/doc/COMPILER.md index 90ecf9f1..36874ad3 100644 --- a/doc/COMPILER.md +++ b/doc/COMPILER.md @@ -52,6 +52,7 @@ ComponentFile { options: [Object], compiler: [Object], tree: [Object], + log: [Object], result: [Object], manifest: undefined, _output: {}, @@ -269,7 +270,7 @@ The final phase writes the generated files to disc. --- -Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 +Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 3, 2016 [trucks]: https://github.com/tmpfs/trucks [trucks-cli]: https://github.com/tmpfs/trucks/blob/master/packages/trucks-cli @@ -300,6 +301,7 @@ Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 [write]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-write [transform-csp]: https://github.com/tmpfs/trucks/blob/master/packages/transform-csp [bundle]: https://github.com/tmpfs/trucks/blob/master/packages/transform-bundle +[copy]: https://github.com/tmpfs/trucks/blob/master/packages/transform-copy [skate]: https://github.com/tmpfs/trucks/blob/master/packages/transform-skate [stylus]: https://github.com/tmpfs/trucks/blob/master/packages/transform-stylus [less]: https://github.com/tmpfs/trucks/blob/master/packages/transform-less diff --git a/doc/DEVELOPER.md b/doc/DEVELOPER.md index 31920a9e..8a9dcb76 100644 --- a/doc/DEVELOPER.md +++ b/doc/DEVELOPER.md @@ -145,7 +145,7 @@ mk compiler --- -Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 +Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 3, 2016 [trucks]: https://github.com/tmpfs/trucks [trucks-cli]: https://github.com/tmpfs/trucks/blob/master/packages/trucks-cli @@ -176,6 +176,7 @@ Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 [write]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-write [transform-csp]: https://github.com/tmpfs/trucks/blob/master/packages/transform-csp [bundle]: https://github.com/tmpfs/trucks/blob/master/packages/transform-bundle +[copy]: https://github.com/tmpfs/trucks/blob/master/packages/transform-copy [skate]: https://github.com/tmpfs/trucks/blob/master/packages/transform-skate [stylus]: https://github.com/tmpfs/trucks/blob/master/packages/transform-stylus [less]: https://github.com/tmpfs/trucks/blob/master/packages/transform-less diff --git a/doc/INTRO.md b/doc/INTRO.md index 3c9890c8..fd786ef8 100644 --- a/doc/INTRO.md +++ b/doc/INTRO.md @@ -33,7 +33,7 @@ Another benefit of this library is that it converts [HTML Imports][html-imports] --- -Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 +Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 3, 2016 - [Introduction](#introduction) - [Polymer](#polymer) diff --git a/doc/OPTIONS.md b/doc/OPTIONS.md index e24eb6e1..8441daaa 100644 --- a/doc/OPTIONS.md +++ b/doc/OPTIONS.md @@ -68,7 +68,7 @@ module.exports = options; --- -Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 +Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 3, 2016 [trucks]: https://github.com/tmpfs/trucks [trucks-cli]: https://github.com/tmpfs/trucks/blob/master/packages/trucks-cli @@ -99,6 +99,7 @@ Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 [write]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-write [transform-csp]: https://github.com/tmpfs/trucks/blob/master/packages/transform-csp [bundle]: https://github.com/tmpfs/trucks/blob/master/packages/transform-bundle +[copy]: https://github.com/tmpfs/trucks/blob/master/packages/transform-copy [skate]: https://github.com/tmpfs/trucks/blob/master/packages/transform-skate [stylus]: https://github.com/tmpfs/trucks/blob/master/packages/transform-stylus [less]: https://github.com/tmpfs/trucks/blob/master/packages/transform-less diff --git a/doc/ROADMAP.md b/doc/ROADMAP.md deleted file mode 100644 index af064114..00000000 --- a/doc/ROADMAP.md +++ /dev/null @@ -1,134 +0,0 @@ -## Roadmap - -These features are not available yet however this section describes how they may be implemented. - ---- - -- [Roadmap](#roadmap) - - [Packages](#packages) - - [Styles](#styles) - - [Documentation](#documentation) - ---- - -### Packages - -Sharing web components in a package manager agnostic format would be very useful. Currently component groups only support loading from the local filesystem but this should be refactored to a plugin system that maps to a scheme URL allowing loading components from various locations. - -For example we could register a `trucks-npm` plugin and load components from [npm][] packages: - -```html - -``` - -Suggested schemes to implement: - -* `npm://` -* `https://` -* `git+ssh://` - -Later support could be added for: - -* `bower://` -* `jspm://` -* `component://` - -### Styles - -Whilst experimenting with [polymer][] it was noticed that there is a certain amount of redundancy when styling components authored by third parties. Component authors need to provide default styles for their components whilst component consumers normally need to modify the default styles. - -It would not be very difficult to allow a pre-compile phase that maps component identifiers to stylesheets that can replace or be merged with the default styles provided by the component author. - -This would reduce the file size of component styles and prevent consumers from battling against CSS specificity issues when attempting to override the default component styles. - -The suggestion is that this would be implemented as [postcss plugins][postcss]. - -### Documentation - -Component authors should have a consistent approach to writing documentation for the created components so that users can easily see the component attributes, events and other aspects of the component (dependencies etc). - -The suggestion is that in the future we could use the [mkapi][] and [mkparse][] libraries to generate markdown documentation for components, a draft idea of how this would look: - -```html - - - - - - - - -``` - -The generated markdown document would render the documentation comments followed by fenced code blocks showing the example usage(s) and the component implementation, these pages could then be converted to HTML (with source code higlighting) to be published online as static web pages. - ---- - -Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 2, 2016 - -[trucks]: https://github.com/tmpfs/trucks -[trucks-cli]: https://github.com/tmpfs/trucks/blob/master/packages/trucks-cli -[skatejs]: https://github.com/skatejs/skatejs -[webcomponents]: https://github.com/w3c/webcomponents -[shadow-dom]: https://w3c.github.io/webcomponents/spec/shadow/ -[custom-elements]: https://www.w3.org/TR/custom-elements/ -[html-imports]: https://w3c.github.io/webcomponents/spec/imports/ -[html-templates]: https://html.spec.whatwg.org/multipage/scripting.html#the-template-element -[polymer]: https://www.polymer-project.org/1.0/ -[react]: https://facebook.github.io/react/ -[react-webcomponents]: https://github.com/facebook/react/issues/5052 -[react-integration]: https://github.com/skatejs/react-integration -[mozilla-webcomponents]: https://hacks.mozilla.org/2014/12/mozilla-and-web-components/ -[csp]: http://content-security-policy.com/ -[npm]: https://www.npmjs.com/ -[postcss]: https://github.com/postcss/postcss -[mkdoc]: https://github.com/mkdoc/mkdoc -[mkapi]: https://github.com/mkdoc/mkapi -[mkparse]: https://github.com/mkdoc/mkparse -[jshint]: http://jshint.com -[jscs]: http://jscs.info -[sources]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-sources -[load]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-load -[parse]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-parse -[transform]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-transform -[generate]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-generate -[write]: https://github.com/tmpfs/trucks/blob/master/packages/plugin-write -[transform-csp]: https://github.com/tmpfs/trucks/blob/master/packages/transform-csp -[bundle]: https://github.com/tmpfs/trucks/blob/master/packages/transform-bundle -[skate]: https://github.com/tmpfs/trucks/blob/master/packages/transform-skate -[stylus]: https://github.com/tmpfs/trucks/blob/master/packages/transform-stylus -[less]: https://github.com/tmpfs/trucks/blob/master/packages/transform-less -[sass]: https://github.com/tmpfs/trucks/blob/master/packages/transform-sass -[trim]: https://github.com/tmpfs/trucks/blob/master/packages/transform-trim -[tree]: https://github.com/tmpfs/trucks/blob/master/packages/transform-tree -[style-extract]: https://github.com/tmpfs/trucks/blob/master/packages/transform-style-extract -[style-inject]: https://github.com/tmpfs/trucks/blob/master/packages/transform-style-inject -[resolver-core]: https://github.com/tmpfs/trucks/blob/master/packages/resolver-core -[resolver-file]: https://github.com/tmpfs/trucks/blob/master/packages/resolver-file -[resolver-http]: https://github.com/tmpfs/trucks/blob/master/packages/resolver-http -[resolver-npm]: https://github.com/tmpfs/trucks/blob/master/packages/resolver-npm -[less-css]: http://lesscss.org/ -[sass-css]: http://sass-lang.com/ -[stylus-css]: http://stylus-lang.com/ -[node-sass]: https://github.com/sass/node-sass -[archy]: https://github.com/substack/node-archy - diff --git a/doc/readme.md b/doc/readme.md index f15f816b..792c7aac 100644 --- a/doc/readme.md +++ b/doc/readme.md @@ -55,8 +55,6 @@ An example for [skatejs][] is in [skate-component](/examples/skate-component). For the API docs see [API](/doc/API.md), an overview of the available options is in [OPTIONS](/doc/OPTIONS.md). For insights into the compiler phases and data structures see [COMPILER](/doc/COMPILER.md). -The [ROADMAP](/doc/ROADMAP.md) has some ideas for future features. - Information on how to build this project is in [DEVELOPER](/doc/DEVELOPER.md). -*** - -### Packages - -Sharing web components in a package manager agnostic format would be very useful. Currently component groups only support loading from the local filesystem but this should be refactored to a plugin system that maps to a scheme URL allowing loading components from various locations. - -For example we could register a `trucks-npm` plugin and load components from [npm][] packages: - -```html - -``` - -Suggested schemes to implement: - -* `npm://` -* `https://` -* `git+ssh://` - -Later support could be added for: - -* `bower://` -* `jspm://` -* `component://` - -### Styles - -Whilst experimenting with [polymer][] it was noticed that there is a certain amount of redundancy when styling components authored by third parties. Component authors need to provide default styles for their components whilst component consumers normally need to modify the default styles. - -It would not be very difficult to allow a pre-compile phase that maps component identifiers to stylesheets that can replace or be merged with the default styles provided by the component author. - -This would reduce the file size of component styles and prevent consumers from battling against CSS specificity issues when attempting to override the default component styles. - -The suggestion is that this would be implemented as [postcss plugins][postcss]. - -### Documentation - -Component authors should have a consistent approach to writing documentation for the created components so that users can easily see the component attributes, events and other aspects of the component (dependencies etc). - -The suggestion is that in the future we could use the [mkapi][] and [mkparse][] libraries to generate markdown documentation for components, a draft idea of how this would look: - -```html - - - - - - - - -``` - -The generated markdown document would render the documentation comments followed by fenced code blocks showing the example usage(s) and the component implementation, these pages could then be converted to HTML (with source code higlighting) to be published online as static web pages. - - diff --git a/mkdoc.js b/mkdoc.js index cbcd4b23..7c9ccada 100644 --- a/mkdoc.js +++ b/mkdoc.js @@ -164,13 +164,6 @@ function api(cb) { doc('doc/api/api.md', 'doc/API.md', {toc: {depth: 2}}, cb); } -// @task roadmap build the roadmap file -function roadmap(cb) { - doc( - 'doc/roadmap/roadmap.md', 'doc/ROADMAP.md', - {toc: {depth: 2, max: 3}}, cb); -} - // @task options build the options file function options(cb) { doc( @@ -212,7 +205,6 @@ mk.task(cover); mk.task(intro); mk.task(api); -mk.task(roadmap); mk.task(options); mk.task(developer); mk.task(compiler); @@ -221,7 +213,6 @@ mk.task(readme); mk.task([ intro, api, - roadmap, options, developer, compiler,