From 5f4dd812c58abd4567b01d453f9b4e879d707dcc Mon Sep 17 00:00:00 2001 From: Zalmoxisus Date: Mon, 6 Feb 2017 12:33:01 +0200 Subject: [PATCH] [docs] Fix links --- docs/API/Methods.md | 2 +- docs/FAQ.md | 5 ++--- docs/Integrations.md | 2 +- docs/Troubleshooting.md | 8 +++----- 4 files changed, 7 insertions(+), 10 deletions(-) diff --git a/docs/API/Methods.md b/docs/API/Methods.md index caafc2b5..a7fd799d 100644 --- a/docs/API/Methods.md +++ b/docs/API/Methods.md @@ -56,7 +56,7 @@ Send a new action and state manually to be shown on the monitor. It's recommende - `action` *String* (action type) or *Object* with required `type` key. - `state` *any* - usually object to expand. - [`options`] *Object* - [see the available options](Arguments.md). -- [`instanceId`] *String* - instance id for which to include the log. +- [`instanceId`] *String* - instance id for which to include the log. If not specified and not present in the `options` object, will be the first available instance. ### listen(onMessage, instanceId) diff --git a/docs/FAQ.md b/docs/FAQ.md index 1836ae9b..3c6f4b8c 100644 --- a/docs/FAQ.md +++ b/docs/FAQ.md @@ -2,14 +2,13 @@ ## Table of Contents - [How to get it work](#how-to-get-it-work) -- [How to disable/enable it in production](#how-to-disableenable-it-in-production) +- [How to disable/enable it in production](#how-to-disable-it-in-production) - [How to persist debug sessions across page reloads](#how-to-persist-debug-sessions-across-page-reloads) - [How to open DevTools programmatically](#how-to-open-devtools-programmatically) -- [How to keep DevTools window focused all the time in a chrome panel](#how-to-open-devtools-programmatically) +- [How to keep DevTools window focused all the time in a chrome panel](#how-to-keep-devtools-window-focused-all-the-time-in-a-chrome-panel) - [How to enable/disable errors notifying](#how-to-enabledisable-errors-notifying) - [How to get it work with WebWorkers, React Native, hybrid, desktop and server side apps](#how-to-get-it-work-with-webworkers-react-native-hybrid-desktop-and-server-side-apps) - [Keyboard shortcuts](#keyboard-shortcuts) -- [How to change keyboard shortcuts](#how-to-change-keyboard-shortcuts) #### How to get it work - Check the extension with [Counter](http://zalmoxisus.github.io/examples/counter/) or [TodoMVC](http://zalmoxisus.github.io/examples/todomvc/) demo. diff --git a/docs/Integrations.md b/docs/Integrations.md index 57ef2fe4..b479221e 100644 --- a/docs/Integrations.md +++ b/docs/Integrations.md @@ -1,4 +1,4 @@ -# Integrations for different languages and frameworks +# Integrations for js and non-js frameworks Mostly functional: - [Angular](#angular) diff --git a/docs/Troubleshooting.md b/docs/Troubleshooting.md index 41c7ad28..532b6db0 100644 --- a/docs/Troubleshooting.md +++ b/docs/Troubleshooting.md @@ -18,7 +18,7 @@ Most likely you mutate the state. Check it by [adding `redux-immutable-state-inv ### It doesn't work with other store enhancers -Usually the extension's store enhancer should be last in the compose. When you're using `window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__` or `composeWithDevTools` helper you don't have to worry about the enhancers order. However some enhancers ([like `redux-batched-subscribe`](https://github.com/zalmoxisus/redux-devtools-extension/issues/261)) also have this requirement to be the last in the compose. In this case you can use it like so: +Usually the extension's store enhancer should be last in the compose. When you're using [`window.__REDUX_DEVTOOLS_EXTENSION_COMPOSE__`](/README.md#12-advanced-store-setup) or [`composeWithDevTools`](/README.md#13-use-redux-devtools-extension-package-from-npm) helper you don't have to worry about the enhancers order. However some enhancers ([like `redux-batched-subscribe`](https://github.com/zalmoxisus/redux-devtools-extension/issues/261)) also have this requirement to be the last in the compose. In this case you can use it like so: ```js const store = createStore(reducer, preloadedState, compose( @@ -76,12 +76,10 @@ React synthetic event cannot be reused for performance reason. So, it's not poss ### Symbols or other unserializable data not shown -To get data which cannot be serialized by `JSON.stringify`, use `serialize` parameter, setting `options` to `true`: +To get data which cannot be serialized by `JSON.stringify`, set [`serialize` parameter](/docs/API/Arguments.md#serialize): ```js const store = Redux.createStore(reducer, window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__({ - serialize: { - options: true - } + serialize: true })); ```