Misc documentation fixes - part 2 (#335)

* Docs: Stop using a relative URL for the docs contributing links Since unlike links pointing at eg API docs, the contributing links don't need to stay in sync with the version being browsed. Using the same link on both the `packages/` and `docs/` locations reduces the diffs considerable when trying to keep the files in sync. * Docs: Sync CONTRIBUTING.md with docs/contributing/README.md * Docs: Clarify that the static directory is named `static` * Docs: Remove trailing whitespace from webpack-chain.md * Docs: Restore changes from #325 lost after merge conflicts * Docs: Sync the READMEs in docs/ and packages/ * Docs: Sync the react and web preset feature lists
neutrinojs · Sep 30, 2017 · 97ca8b8 · 97ca8b8
1 parent 1a707f6
commit 97ca8b8
Show file tree

Hide file tree

Showing 34 changed files with 66 additions and 55 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -44,9 +44,11 @@ externally.
 ## Support
 
 Neutrino team members and contributors are here to help you! Should you need assistance or have questions in using
-Neutrino or its core presets, please consider asking on Stack Overflow or other channel rather than filing issues. We
-would prefer to keep our GitHub issues clear for bugs, feature requests, discussions, and relevant information related
-to its development.
+Neutrino or its core presets, please consider asking on our Slack channel, Stack Overflow, or other channel rather than
+filing issues. We would prefer to keep our GitHub issues clear for bugs, feature requests, discussions, and
+relevant information related to its development.
+
+[Join our Slack channel!](https://neutrino-slack.herokuapp.com/)
 
 ## Guidelines
 

diff --git a/docs/middleware/neutrino-middleware-banner/README.md b/docs/middleware/neutrino-middleware-banner/README.md
@@ -89,7 +89,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-banner.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-banner.svg

diff --git a/docs/middleware/neutrino-middleware-chunk/README.md b/docs/middleware/neutrino-middleware-chunk/README.md
@@ -66,7 +66,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-chunk.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-chunk.svg

diff --git a/docs/middleware/neutrino-middleware-clean/README.md b/docs/middleware/neutrino-middleware-clean/README.md
@@ -80,7 +80,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-clean.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-clean.svg

diff --git a/docs/middleware/neutrino-middleware-compile-loader/README.md b/docs/middleware/neutrino-middleware-compile-loader/README.md
@@ -126,7 +126,7 @@ The following is a list of rules and their identifiers which can be overridden:
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-compile-loader.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-compile-loader.svg

diff --git a/docs/middleware/neutrino-middleware-copy/README.md b/docs/middleware/neutrino-middleware-copy/README.md
@@ -86,7 +86,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-copy.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-copy.svg

diff --git a/docs/middleware/neutrino-middleware-dev-server/README.md b/docs/middleware/neutrino-middleware-dev-server/README.md
@@ -131,7 +131,7 @@ may also specify the following options:
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-dev-server.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-dev-server.svg

diff --git a/docs/middleware/neutrino-middleware-env/README.md b/docs/middleware/neutrino-middleware-env/README.md
@@ -78,7 +78,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-env.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-env.svg

diff --git a/docs/middleware/neutrino-middleware-eslint/README.md b/docs/middleware/neutrino-middleware-eslint/README.md
@@ -194,7 +194,7 @@ in the [ESLint user guide](http://eslint.org/docs/user-guide/configuring#ignorin
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-eslint.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-eslint.svg

diff --git a/docs/middleware/neutrino-middleware-font-loader/README.md b/docs/middleware/neutrino-middleware-font-loader/README.md
@@ -91,7 +91,7 @@ The following is a list of rules and their identifiers which can be overridden:
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-font-loader.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-font-loader.svg

diff --git a/docs/middleware/neutrino-middleware-hot/README.md b/docs/middleware/neutrino-middleware-hot/README.md
@@ -62,7 +62,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-hot.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-hot.svg

diff --git a/docs/middleware/neutrino-middleware-html-loader/README.md b/docs/middleware/neutrino-middleware-html-loader/README.md
@@ -80,7 +80,7 @@ The following is a list of rules and their identifiers which can be overridden:
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-html-loader.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-html-loader.svg

diff --git a/docs/middleware/neutrino-middleware-html-template/README.md b/docs/middleware/neutrino-middleware-html-template/README.md
@@ -107,7 +107,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-html-template.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-html-template.svg

diff --git a/docs/middleware/neutrino-middleware-image-loader/README.md b/docs/middleware/neutrino-middleware-image-loader/README.md
@@ -91,7 +91,7 @@ The following is a list of rules and their identifiers which can be overridden:
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-image-loader.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-image-loader.svg

diff --git a/docs/middleware/neutrino-middleware-loader-merge/README.md b/docs/middleware/neutrino-middleware-loader-merge/README.md
@@ -68,7 +68,7 @@ for extending the options for a rule loader which has created its own convention
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-loader-merge.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-loader-merge.svg

diff --git a/docs/middleware/neutrino-middleware-minify/README.md b/docs/middleware/neutrino-middleware-minify/README.md
@@ -79,13 +79,13 @@ The following is a list of plugins and their identifiers which can be overridden
 
 | Name | Description | Environments and Commands |
 | --- | --- | --- |
-| `minify` | Minifies source code using `BabelMinifyWebpackPlugin` | all |
+| `minify` | Minifies source code using `BabelMinifyWebpackPlugin`. | all |
 
 ## Contributing
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-minify.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-minify.svg

diff --git a/docs/middleware/neutrino-middleware-pwa/README.md b/docs/middleware/neutrino-middleware-pwa/README.md
@@ -115,7 +115,7 @@ The following is a list of plugins and their identifiers which can be overridden
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-pwa.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-pwa.svg

diff --git a/docs/middleware/neutrino-middleware-start-server/README.md b/docs/middleware/neutrino-middleware-start-server/README.md
@@ -87,7 +87,7 @@ This can be done from the [API](../../api#optionsdebug) or the [CLI using `--deb
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-start-server.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-start-server.svg

diff --git a/docs/middleware/neutrino-middleware-style-loader/README.md b/docs/middleware/neutrino-middleware-style-loader/README.md
@@ -83,7 +83,7 @@ The following is a list of rules and their identifiers which can be overridden:
 
 This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-middleware-style-loader.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-style-loader.svg

diff --git a/docs/presets/neutrino-preset-airbnb-base/README.md b/docs/presets/neutrino-preset-airbnb-base/README.md
@@ -312,7 +312,7 @@ in the [ESLint user guide](http://eslint.org/docs/user-guide/configuring#ignorin
 
 This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-preset-airbnb-base.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-airbnb-base.svg

diff --git a/docs/presets/neutrino-preset-jest/README.md b/docs/presets/neutrino-preset-jest/README.md
@@ -275,7 +275,7 @@ module.exports = {
 
 This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-preset-jest.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-jest.svg

diff --git a/docs/presets/neutrino-preset-karma/README.md b/docs/presets/neutrino-preset-karma/README.md
@@ -196,7 +196,7 @@ module.exports = {
 
 This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-preset-karma.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-karma.svg

diff --git a/docs/presets/neutrino-preset-mocha/README.md b/docs/presets/neutrino-preset-mocha/README.md
@@ -208,7 +208,7 @@ module.exports = {
 
 This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-preset-mocha.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-mocha.svg

diff --git a/docs/presets/neutrino-preset-node/README.md b/docs/presets/neutrino-preset-node/README.md
@@ -332,7 +332,7 @@ module.exports = {
 
 This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-preset-node.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-node.svg

diff --git a/docs/presets/neutrino-preset-react/README.md b/docs/presets/neutrino-preset-react/README.md
@@ -16,7 +16,7 @@
   - Automatic creation of HTML pages, no templating necessary
   - Hot Module Replacement support
   - Tree-shaking to create smaller bundles
-  - Production-optimized bundles with Babili minification and easy chunking
+  - Production-optimized bundles with Babili minification, easy chunking, and scope-hoisted modules for faster execution
   - Easily extensible to customize your project as needed
 
 ## Requirements
@@ -272,7 +272,7 @@ load();
 
 This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-preset-react.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-react.svg

diff --git a/docs/presets/neutrino-preset-web/README.md b/docs/presets/neutrino-preset-web/README.md
@@ -12,7 +12,7 @@
 - Automatic creation of HTML pages, no templating necessary
 - Hot Module Replacement support
 - Tree-shaking to create smaller bundles
-- Production-optimized bundles with Babili minification and easy chunking
+- Production-optimized bundles with Babili minification, easy chunking, and scope-hoisted modules for faster execution
 - Easily extensible to customize your project as needed
 
 ## Requirements
@@ -268,7 +268,7 @@ The following is a list of rules and their identifiers which can be overridden:
 | Name | Description | Environments and Commands |
 | --- | --- | --- |
 | `compile` | Compiles JS files from the `src` directory using Babel. Contains a single loader named `babel`. From `neutrino-middleware-compile-loader`. | all |
-| `html` | Allows importing HTML files from modules. Contains a single loader named `file`. From `neutrino-middleware-html-loader`. | all |
+| `html` | Allows importing HTML files from modules. Contains a single loader named `html`. From `neutrino-middleware-html-loader`. | all |
 | `style` | Allows importing CSS stylesheets from modules. Contains two loaders named `style` and `css`. From `neutrino-middleware-style-loader`. | all |
 | `img`, `svg`, `ico` | Allows import image files from modules. Each contains a single loader named `url`. From `neutrino-middleware-image-loader`. | all |
 | `woff`, `ttf` | Allows importing WOFF and TTF font files from modules. Each contains a single loader named `url`. From `neutrino-middleware-font-loader`. | all |
@@ -281,8 +281,6 @@ The following is a list of plugins and their identifiers which can be overridden
 
 _Note: Some plugins are only available in certain environments. To override them, they should be modified conditionally._
 
-### Override configuration
-
 | Name | Description | Environments and Commands |
 | --- | --- | --- |
 | `env` | Inject environment variables into source code at `process.env`, defaults to only inject `NODE_ENV`. From `neutrino-middleware-env`. | all |
@@ -298,6 +296,8 @@ _Note: Some plugins are only available in certain environments. To override them
 | `minify` | Minifies source code using `BabiliWebpackPlugin`. From `neutrino-middleware-minify`. | `NODE_ENV production` |
 | `module-concat` | Concatenate the scope of all your modules into one closure and allow for your code to have a faster execution time in the browser. | `NODE_ENV production` |
 
+### Override configuration
+
 By following the [customization guide](../../customization) and knowing the rule, loader, and plugin IDs above,
 you can override and augment the build by by providing a function to your `.neutrinorc.js` use array. You can also
 make these changes from the Neutrino API in custom middleware.
@@ -322,7 +322,7 @@ module.exports = {
 
 This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
 containing all resources for developing Neutrino and its core presets and middleware. Follow the
-[contributing guide](../../contributing/README.md) for details.
+[contributing guide](https://neutrino.js.org/contributing) for details.
 
 [npm-image]: https://img.shields.io/npm/v/neutrino-preset-web.svg
 [npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-web.svg

diff --git a/docs/project-layout.md b/docs/project-layout.md
@@ -26,7 +26,7 @@ necessary for creating your builds.
 
 When creating a build bundle, a preset will put the compiled assets, including any generated
 JavaScript files, into a directory named `build` by default. Typically your Neutrino preset will copy
-any files from the static directory over to the build directory, allowing you to maintain
+any files from the `static` directory over to the build directory, allowing you to maintain
 the same relative path structure for static assets as is used for the source files.
 
 Normally most projects will exclude checking in this build directory to source control.

diff --git a/docs/webpack-chain.md b/docs/webpack-chain.md
@@ -97,7 +97,7 @@ module.exports = (neutrino) => {
             ['babel-preset-es2015', { modules: false }]
           ]
         });
-  
+
   // Create named plugins too!
   neutrino.config
     .plugin('clean')
@@ -557,7 +557,7 @@ neutrino.config
 ```
 
 #### Config plugins: removing
- 
+
 ```js
 neutrino.config.plugins.delete(name)
 ```
@@ -596,7 +596,7 @@ neutrino.config.resolve
 ```
 
 #### Config resolve plugins: removing
- 
+
 ```js
 neutrino.config.resolve.plugins.delete(name)
 ```