diff --git a/.gitignore b/.gitignore index 5dc6d1ef2..1c9c25433 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -/doc/autogenerated/ +/docs/js/ /.nyc_output/ /node_modules/ /vendor/ diff --git a/doc/adr/0001-record-architecture-decisions.md b/docs/adr/0001-record-architecture-decisions.md similarity index 100% rename from doc/adr/0001-record-architecture-decisions.md rename to docs/adr/0001-record-architecture-decisions.md diff --git a/doc/adr/0002-contain-and-manage-state.md b/docs/adr/0002-contain-and-manage-state.md similarity index 100% rename from doc/adr/0002-contain-and-manage-state.md rename to docs/adr/0002-contain-and-manage-state.md diff --git a/doc/adr/0003-keep-enabled-state-only-in-preview-reducer.md b/docs/adr/0003-keep-enabled-state-only-in-preview-reducer.md similarity index 100% rename from doc/adr/0003-keep-enabled-state-only-in-preview-reducer.md rename to docs/adr/0003-keep-enabled-state-only-in-preview-reducer.md diff --git a/doc/adr/0004-use-webpack.md b/docs/adr/0004-use-webpack.md similarity index 100% rename from doc/adr/0004-use-webpack.md rename to docs/adr/0004-use-webpack.md diff --git a/doc/adr/0005-frontend-sources-directory-structure.md b/docs/adr/0005-frontend-sources-directory-structure.md similarity index 100% rename from doc/adr/0005-frontend-sources-directory-structure.md rename to docs/adr/0005-frontend-sources-directory-structure.md diff --git a/doc/adr/0006-factories.md b/docs/adr/0006-factories.md similarity index 100% rename from doc/adr/0006-factories.md rename to docs/adr/0006-factories.md diff --git a/doc/adr/0007-prefer-running-qunit-tests-in-node-js.md b/docs/adr/0007-prefer-running-qunit-tests-in-node-js.md similarity index 100% rename from doc/adr/0007-prefer-running-qunit-tests-in-node-js.md rename to docs/adr/0007-prefer-running-qunit-tests-in-node-js.md diff --git a/doc/adr/0008-enable-minification-of-bundle-with-uglifyjs.md b/docs/adr/0008-enable-minification-of-bundle-with-uglifyjs.md similarity index 100% rename from doc/adr/0008-enable-minification-of-bundle-with-uglifyjs.md rename to docs/adr/0008-enable-minification-of-bundle-with-uglifyjs.md diff --git a/doc/adr/0009-utilize-browser-caching.md b/docs/adr/0009-utilize-browser-caching.md similarity index 100% rename from doc/adr/0009-utilize-browser-caching.md rename to docs/adr/0009-utilize-browser-caching.md diff --git a/doc/adr/0010-replace-mustache-js-with-template-literals.md b/docs/adr/0010-replace-mustache-js-with-template-literals.md similarity index 100% rename from doc/adr/0010-replace-mustache-js-with-template-literals.md rename to docs/adr/0010-replace-mustache-js-with-template-literals.md diff --git a/doc/change_listener.md b/docs/change_listener.md similarity index 100% rename from doc/change_listener.md rename to docs/change_listener.md diff --git a/doc/images/instrumentation/data_flow.jpg b/docs/images/instrumentation/data_flow.jpg similarity index 100% rename from doc/images/instrumentation/data_flow.jpg rename to docs/images/instrumentation/data_flow.jpg diff --git a/doc/instrumentation.md b/docs/instrumentation.md similarity index 100% rename from doc/instrumentation.md rename to docs/instrumentation.md diff --git a/jsdoc.json b/jsdoc.json index 89c3527f9..1faeb6939 100644 --- a/jsdoc.json +++ b/jsdoc.json @@ -1,18 +1,21 @@ { - "source": { - "include": [ - "src/" - ] - }, "opts": { - "destination": "doc/autogenerated/", + "destination": "docs/js", + "package": "package.json", "pedantic": true, + "readme": "README.md", "recurse": true }, "plugins": [ "plugins/markdown" ], - "tags": { - "allowUnknownTags": true + "source": { + "include": [ "src" ] + }, + "templates": { + "cleverLinks": true, + "default": { + "useLongnameInNav": true + } } } diff --git a/resources/dist/index.js.json b/resources/dist/index.js.json index 4d14c44a0..64a47966e 100644 Binary files a/resources/dist/index.js.json and b/resources/dist/index.js.json differ diff --git a/src/actions.js b/src/actions.js index 777c76c07..ef74ca023 100644 --- a/src/actions.js +++ b/src/actions.js @@ -403,7 +403,7 @@ export function hideSettings() { * place (the preview reducer), we query it and dispatch it as `wasEnabled` * so that other reducers (like settings) can act on it without having to * duplicate the `enabled` state locally. - * See doc/adr/0003-keep-enabled-state-only-in-preview-reducer.md for more + * See docs/adr/0003-keep-enabled-state-only-in-preview-reducer.md for more * details. * * @param {boolean} enabled if previews are enabled or not diff --git a/src/reducers/nextState.js b/src/reducers/nextState.js index cfee5d5b1..befc563d6 100644 --- a/src/reducers/nextState.js +++ b/src/reducers/nextState.js @@ -8,7 +8,7 @@ * the state we need to manually iterate over updates and check with * hasOwnProperty to copy over to the new state. * - * In [change listeners](/doc/change_listeners.md), for example, we talk about + * In [change listeners](/docs/change_listener.md), for example, we talk about * the previous state and the current state (the `prevState` and `state` * parameters, respectively). Since * [reducers](http://redux.js.org/docs/basics/Reducers.html) take the current