Skip to content

Commit 62bf417

Browse files
authored
Update docs setup (#52)
1 parent 6da70cb commit 62bf417

File tree

13 files changed

+477
-306
lines changed

13 files changed

+477
-306
lines changed

docs/introduction/quick-start.md

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,19 @@ hide_title: true
99

1010
## Purpose
1111

12-
The `redux-starter-kit` package is intended to help address three common complaints about Redux:
12+
The **`redux-starter-kit`** package is intended to help address three common concerns about Redux:
1313

1414
- "Configuring a Redux store is too complicated"
1515
- "I have to add a lot of packages to get Redux to do anything useful"
1616
- "Redux requires too much boilerplate code"
1717

1818
We can't solve every use case, but in the spirit of [`create-react-app`](https://github.com/facebook/create-react-app) and [`apollo-boost`](https://dev-blog.apollodata.com/zero-config-graphql-state-management-27b1f1b3c2c3), we can try to provide some tools that abstract over the setup process and handle the most common use cases, as well as include some useful utilities that will let the user simplify their application code.
1919

20-
This package is _not_ intended to solve every possible complaint about Redux, and is deliberately limited in scope. It does _not_ address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.
20+
This package is _not_ intended to solve every possible concern about Redux, and is deliberately limited in scope. It does _not_ address concepts like "reusable encapsulated Redux modules", data fetching, folder or file structures, managing entity relationships in the store, and so on.
21+
22+
That said, **these tools should be beneficial to all Redux users**. Whether you're a brand new Redux user setting up your
23+
first project, or an experienced user who wants to simplify an existing application, **`redux-starter-kit`** can help
24+
you make your Redux code better.
2125

2226
## What's Included
2327

@@ -31,11 +35,18 @@ This package is _not_ intended to solve every possible complaint about Redux, an
3135

3236
## Installation
3337

34-
`redux-startr-kit` is available as a package on NPM for use with a module bundler or in a Node application:
38+
`redux-starter-kit` is available as a package on NPM for use with a module bundler or in a Node application:
3539

3640
```bash
37-
npm install --save redux-startr-kit
41+
npm install --save redux-starter-kit
3842
```
3943

4044
It is also available as a precompiled UMD package that defines a `window['redux-starter-kit']` global variable.
4145
The UMD package can be used as a [`<script>` tag](https://unpkg.com/redux-starter-kit/dist/redux-starter-kit.umd.js) directly.
46+
47+
48+
## Help and Discussion
49+
50+
The **[#redux channel](https://discord.gg/0ZcbPKXt5bZ6au5t)** of the **[Reactiflux Discord community](http://www.reactiflux.com)** is our official resource for all questions related to learning and using Redux. Reactiflux is a great place to hang out, ask questions, and learn - come join us!
51+
52+
You can also ask questions on [Stack Overflow](https://stackoverflow.com) using the **[#redux tag](https://stackoverflow.com/questions/tagged/redux)**.

website/core/Footer.js

Lines changed: 18 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ const React = require('react')
99

1010
class Footer extends React.Component {
1111
docUrl(doc, language) {
12-
const baseUrl = this.props.config.baseUrl
13-
return `${baseUrl}docs/${language ? `${language}/` : ''}${doc}`
12+
const baseUrl = this.props.config.baseUrl;
13+
return `${baseUrl}${language ? `${language}/` : ""}${doc}`;
1414
}
1515

1616
pageUrl(doc, language) {
@@ -34,30 +34,27 @@ class Footer extends React.Component {
3434
</a>
3535
<div>
3636
<h5>Docs</h5>
37-
<a href={this.docUrl('introduction/quick-start')}>Introduction</a>
38-
<a
39-
href={this.docUrl(
40-
'using-redux-starter-kit/connect-extracting-data-with-mapStateToProps'
41-
)}
42-
>
43-
Using redux-starter-kit
37+
<a href={this.docUrl("introduction/quick-start")}>
38+
Quick Start
4439
</a>
4540
<a href={this.docUrl('api')}>API Reference</a>
46-
<a href={this.docUrl('troubleshooting')}>Guides</a>
4741
</div>
4842
<div>
4943
<h5>Community</h5>
5044
<a
51-
href="http://stackoverflow.com/questions/tagged/redux-starter-kit"
45+
href="http://stackoverflow.com/questions/tagged/redux"
5246
target="_blank"
5347
rel="noreferrer noopener"
5448
>
5549
Stack Overflow
5650
</a>
51+
<a href="https://discord.gg/0ZcbPKXt5bZ6au5t">
52+
Discord
53+
</a>
5754
</div>
5855
<div>
5956
<h5>More</h5>
60-
<a href="https://github.com/reduxjs/redux-starter-kit/">GitHub</a>
57+
<a href="https://github.com/reduxjs/redux/">GitHub</a>
6158
<a
6259
className="github-button"
6360
href={this.props.config.repoUrl}
@@ -71,6 +68,15 @@ class Footer extends React.Component {
7168
</a>
7269
</div>
7370
</section>
71+
<section className="copyright">
72+
{this.props.config.copyright}<br />
73+
Some icons copyright <a
74+
href="https://fontawesome.com/license/free"
75+
style={{color : "white"}}
76+
>
77+
Font Awesome
78+
</a>
79+
</section>
7480
</footer>
7581
)
7682
}

0 commit comments

Comments
 (0)