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.

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

Docusaurus #3184

Closed
wants to merge 20 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: faq
id: FAQ.md
title: FAQ
sidebar_label: FAQ
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/Feedback.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: feedback
id: Feedback.md
title: Feedback
sidebar_label: Feedback
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/Glossary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: glossary
id: Glossary.md
title: Glossary
sidebar_label: Glossary
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/Troubleshooting.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: troubleshooting
id: Troubleshooting.md
title: Troubleshooting
sidebar_label: Troubleshooting
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/AsyncActions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: async-actions
id: AsyncActions.md
title: Async Actions
sidebar_label: Async Actions
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/AsyncFlow.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: async-flow
id: AsyncFlow.md
title: Async Flow
sidebar_label: Async Flow
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/ExampleRedditAPI.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: example-reddit-api
id: ExampleRedditAPI.md
title: Example: Reddit API
sidebar_label: Example: Reddit API
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/Middleware.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: middleware
id: Middleware.md
title: Middleware
sidebar_label: Middleware
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/NextSteps.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: next-steps
id: NextSteps.md
title: Next Steps
sidebar_label: Next Steps
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: advanced
id: README.md
title: Advanced
sidebar_label: Advanced
hide_title: true
Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/UsageWithReactRouter.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: usage-with-react-router
id: UsageWithReactRouter.md
title: Usage with React Router
sidebar_label: Usage with React Router
hide_title: true
Expand Down Expand Up @@ -67,7 +67,7 @@ We will then import the `<Provider />` from React Redux:
import { Provider } from 'react-redux'
```

We will wrap `<Router />` in `<Provider />` so that route handlers can get [access to the `store`](http://redux.js.org/docs/basics/UsageWithReact.html#passing-the-store).
We will wrap `<Router />` in `<Provider />` so that route handlers can get [access to the `store`](../basics/UsageWithReact.md#passing-the-store).

```js
const Root = ({ store }) => (
Expand Down
2 changes: 1 addition & 1 deletion docs/api/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: api-reference
id: README.md
title: API Reference
sidebar_label: API Reference
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Store.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: store
id: Store.md
title: Store
sidebar_label: Store
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/api/applyMiddleware.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: apply-middleware
id: applyMiddleware.md
title: applyMiddleware
sidebar_label: applyMiddleware
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/api/bindActionCreators.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: bind-action-creators
id: bindActionCreators.md
title: bindActionCreators
sidebar_label: bindActionCreators
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/api/combineReducers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: combine-reducers
id: combineReducers.md
title: combineReducers
sidebar_label: combineReducers
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/api/compose.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: compose
id: compose.md
title: compose
sidebar_label: compose
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/api/createStore.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: create-store
id: createStore.md
title: createStore
sidebar_label: createStore
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/Actions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: actions
id: Actions.md
title: Actions
sidebar_label: Actions
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/DataFlow.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: data-flow
id: DataFlow.md
title: Data flow
sidebar_label: Data flow
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/ExampleTodoList.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: example
id: ExampleTodoList.md
title: Example: Todo List
sidebar_label: Example: Todo List
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: basics
id: README.md
title: Basics
sidebar_label: Basics
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/Reducers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: reducers
id: Reducers.md
title: Reducers
sidebar_label: Reducers
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/Store.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: store
id: Store.md
title: Store
sidebar_label: Store
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/basics/UsageWithReact.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: usage-with-react
id: UsageWithReact.md
title: Usage with React
sidebar_label: Usage with React
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Actions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: actions
id: Actions.md
title: Actions
sidebar_label: Actions
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/CodeStructure.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: code-structure
id: CodeStructure.md
title: Code structure
sidebar_label: Code structure
hide_title: true
Expand Down
4 changes: 2 additions & 2 deletions docs/faq/DesignDecisions.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: design-decisions
id: DesignDecisions.md
title: Design decisions
sidebar_label: Design decisions
hide_title: true
Expand All @@ -20,7 +20,7 @@ hide_title: true
## Design Decisions

### Why doesn't Redux pass the state and action to subscribers?
Subscribers are intended to respond to the state value itself, not the action. Updates to the state are processed synchronously, but notifications to subscribers can be batched or debounced, meaning that subscribers are not always notified with every action. This is a common [performance optimization](http://redux.js.org/docs/faq/Performance.html#performance-update-events) to avoid repeated re-rendering.
Subscribers are intended to respond to the state value itself, not the action. Updates to the state are processed synchronously, but notifications to subscribers can be batched or debounced, meaning that subscribers are not always notified with every action. This is a common [performance optimization](Performance.md#performance-update-events) to avoid repeated re-rendering.

Batching or debouncing is possible by using enhancers to override `store.dispatch` to change the way that subscribers are notified. Also, there are libraries that change Redux to process actions in batches to optimize performance and avoid repeated re-rendering:
* [redux-batch](https://github.com/manaflair/redux-batch) allows passing an array of actions to `store.dispatch()` with only one notification,
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/General.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: general
id: General.md
title: General
sidebar_label: General
hide_title: true
Expand Down
22 changes: 11 additions & 11 deletions docs/faq/ImmutableData.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: immutable-data
id: ImmutableData.md
title: Immutable data
sidebar_label: Immutable data
hide_title: true
Expand Down Expand Up @@ -53,7 +53,7 @@ Such [shallow checking requires immutability](#redux-shallow-checking-requires-i
#### Further Information

**Documentation**
- [Recipes: Prerequisite Reducer Concepts](http://redux.js.org/docs/recipes/reducers/PrerequisiteConcepts.html)
- [Recipes: Prerequisite Reducer Concepts](../recipes/reducers/PrerequisiteConcepts.md)

**Discussions**
- [Reddit: Why Redux Needs Reducers To Be Pure Functions](https://www.reddit.com/r/reactjs/comments/5ecqqv/why_redux_need_reducers_to_be_pure_functions/dacmmjh/?context=3)
Expand Down Expand Up @@ -82,11 +82,11 @@ Redux uses shallow equality checking in its `combineReducers` function to return
#### Further Information

**Documentation**
- [API: combineReducers](http://redux.js.org/docs/api/combineReducers.html)
- [API: combineReducers](../api/combineReducers.md)


#### How does `combineReducers` use shallow equality checking?
The [suggested structure](http://redux.js.org/docs/faq/Reducers.html#reducers-share-state) for a Redux store is to split the state object into multiple "slices" or "domains" by key, and provide a separate reducer function to manage each individual data slice.
The [suggested structure](../faq/Reducers.md#reducers-share-state) for a Redux store is to split the state object into multiple "slices" or "domains" by key, and provide a separate reducer function to manage each individual data slice.

`combineReducers` makes working with this style of structure easier by taking a `reducers` argument that’s defined as a hash table comprising a set of key/value pairs, where each key is the name of a state slice, and the corresponding value is the reducer function that will act on it.

Expand Down Expand Up @@ -115,8 +115,8 @@ This is worth emphasizing: *If the reducers all return the same `state` object p
#### Further Information

**Documentation**
- [API: combineReducers](http://redux.js.org/docs/api/combineReducers.html)
- [Redux FAQ - How do I share state between two reducers? do I have to use `combineReducers`?](http://redux.js.org/docs/faq/Reducers.html#reducers-share-state)
- [API: combineReducers](../api/combineReducers.md)
- [Redux FAQ - How do I share state between two reducers? do I have to use `combineReducers`?](../faq/Reducers.md#reducers-share-state)

**Video**
- [Egghead.io: Redux: Implementing combineReducers() from Scratch](https://egghead.io/lessons/javascript-redux-implementing-combinereducers-from-scratch)
Expand All @@ -136,7 +136,7 @@ It then runs a shallow equality check on its reference to the root state object
#### Further Information

**Documentation**
- [React-Redux Bindings](http://redux.js.org/docs/basics/UsageWithReact.html)
- [React-Redux Bindings](../basics/UsageWithReact.md)

**Articles**
- [API: React-Redux’s connect function and `mapStateToProps`](https://github.com/reduxjs/react-redux/blob/master/docs/api.md#connectmapstatetoprops-mapdispatchtoprops-mergeprops-options)
Expand Down Expand Up @@ -262,8 +262,8 @@ The store will still be updated with the new values for the root state, but beca
#### Further Information

**Documentation**
- [Recipes: Immutable Update Patterns](http://redux.js.org/docs/recipes/reducers/ImmutableUpdatePatterns.html)
- [Troubleshooting: Never mutate reducer arguments](http://redux.js.org/docs/Troubleshooting.html#never-mutate-reducer-arguments)
- [Recipes: Immutable Update Patterns](../recipes/reducers/ImmutableUpdatePatterns.md)
- [Troubleshooting: Never mutate reducer arguments](../Troubleshooting.md#never-mutate-reducer-arguments)


### Why does a reducer mutating the state prevent React-Redux from re-rendering a wrapped component?
Expand Down Expand Up @@ -432,7 +432,7 @@ JavaScript was never designed to provide guaranteed immutable operations. Accord
### Accidental Object Mutation
With JavaScript, you can accidentally mutate an object (such as the Redux state tree) quite easily without realizing it. For example, updating deeply nested properties, creating a new *reference* to an object instead of a new object, or performing a shallow copy rather than a deep copy, can all lead to inadvertent object mutations, and can trip up even the most experienced JavaScript coder.

To avoid these issues, ensure you follow the recommended [immutable update patterns for ES6](http://redux.js.org/docs/recipes/reducers/ImmutableUpdatePatterns.html).
To avoid these issues, ensure you follow the recommended [immutable update patterns for ES6](../recipes/reducers/ImmutableUpdatePatterns.md).

### Verbose Code
Updating complex nested state trees can lead to verbose code that is tedious to write and difficult to debug.
Expand All @@ -449,7 +449,7 @@ For copying very large objects, [plain JavaScript can be over 100 times slower](
#### Further Information

**Documentation**
- [Immutable Update Patterns for ES6](http://redux.js.org/docs/recipes/reducers/ImmutableUpdatePatterns.html)
- [Immutable Update Patterns for ES6](../recipes/reducers/ImmutableUpdatePatterns.md)

**Articles**
- [Immutable.js, persistent data structures and structural sharing](https://medium.com/@dtinth/immutable-js-persistent-data-structures-and-structural-sharing-6d163fbd73d2#.a2jimoiaf)
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Miscellaneous.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: miscellaneous
id: Miscellaneous.md
title: Miscellaneous
sidebar_label: Miscellaneous
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/OrganizingState.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: organizing-state
id: OrganizingState.md
title: Organizing State
sidebar_label: Organizing State
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Performance.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: performance
id: Performance.md
title: Performance
sidebar_label: Performance
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/ReactRedux.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: react-redux
id: ReactRedux.md
title: React Redux
sidebar_label: React Redux
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/Reducers.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: reducers
id: Reducers.md
title: Reducers
sidebar_label: Reducers
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/faq/StoreSetup.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: store-setup
id: StoreSetup.md
title: Store Setup
sidebar_label: Store Setup
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/BasicExample.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: basic-example
id: BasicExample.md
title: Basic Example
sidebar_label: Basic Example
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/Installation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: installation
id: Installation.md
title: Installation
sidebar_label: Installation
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/LearnRedux.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: learn-redux
id: LearnRedux.md
title: Learn Redux
sidebar_label: Learn Redux
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/Resources.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: resources
id: Resources.md
title: Resources
sidebar_label: Resources
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/CoreConcepts.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: core-concepts
id: CoreConcepts.md
title: Core concepts
sidebar_label: Core concepts
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/Ecosystem.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: ecosystem
id: Ecosystem.md
title: Ecosystem
sidebar_label: Ecosystem
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/Examples.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: examples
id: Examples.md
title: Examples
sidebar_label: Examples
hide_title: true
Expand Down
2 changes: 1 addition & 1 deletion docs/introduction/LearningResources.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
id: learning-resources
id: LearningResources.md
title: Learning resources
sidebar_label: Learning resources
hide_title: true
Expand Down
Loading