Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Integrate open documentation PRs into new docs structure #1344

Closed
wants to merge 2 commits into from
Closed

chore(docs): Integrate open documentation PRs into new docs structure #1344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e2f4624
chore(docs): Add note about homebrew installation.
markrickert Dec 13, 2023
777d32a
chore(docs): Update redux to add section about RTK
markrickert Dec 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/plugins/redux.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,22 @@ ReactotronConfig, you'll need to add `reactotron-redux` as plugin
+ export default reactotron
```

Then, add enhancer from `Reactotron.createEnhancer()` to `createStore` as last parameter
## Using Redux Toolkit (RTK)

If you're using RTK, add the enhancer from `Reactotron.createEnhancer()` to `enhancers` in `configureStore`

```diff
import {configureStore} from '@reduxjs/toolkit';
+ import Reactotron from './ReactotronConfig'
const store = configureStore({
... (reducers, middlewares etc),
+ enhancers: __DEV__ ? [Reactotron.createEnhancer!()] : [],
});
```

## Using Classic Redux

Add enhancer from `Reactotron.createEnhancer()` to `createStore` as last parameter

```diff
import { createStore } from 'redux'
Expand All @@ -71,7 +86,7 @@ import { createStore } from 'redux'

Note: passing enhancer as last argument requires redux@>=3.1.0

## If you have middleware
### If you have middleware

```diff
import { createStore } from 'redux'
Expand Down
6 changes: 6 additions & 0 deletions docs/quick-start/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,12 @@ Once installed, you need to add the Reactotron client to your project. Follow on
- [**React Native**](./react-native.md#installing-reactotronapp)
- [**React**](./react-js.md#installing-reactotronapp)

If you run into an [issue](https://github.com/infinitered/reactotron/issues/1140) opening the application on Mac you can install with Homebrew instead.

```
brew cask install reactotron
```
Comment on lines +19 to +23
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure we want to point people to use brew because I believe the last release is still 2.0

Would be interesting to add brew publishing back 👀

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wait someone updated it 🤯


## Where can I find more information?

We recommend that you watch [Darin Wilson's](https://github.com/darinwilson) talk at [Chain React](https://chainreactconf.com/): [Chain React 2018: Debugging and Beyond with Reactotron](https://www.youtube.com/watch?v=UiPo9A9k7xc)!