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

Create the Redux Essentials page, take 2 #3740

Merged
merged 61 commits into from
Jul 13, 2020
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
61 commits
Select commit Hold shift + click to select a range
440b92e
Port admonition and code block CSS from RTK site
markerikson Mar 29, 2020
df95c14
Restructure sidebars to add "Tutorials" section
markerikson Mar 29, 2020
5d3b507
Add empty "Quick Start" tutorial page
markerikson Mar 29, 2020
bfedc21
Bump Docusaurus to alpha.48
markerikson Mar 29, 2020
e9c893a
Fix text color in admonitions
markerikson Mar 29, 2020
70c6cdb
Add blockquote styling for other pages
markerikson Mar 29, 2020
4cfe763
Add DetailedExplanation component
markerikson Mar 29, 2020
75776e6
Initial Quick Start intro content
markerikson Mar 29, 2020
efb22ad
Quick Start: add "What is Redux" and "Terms" sections
markerikson Mar 29, 2020
0fc4460
Quick Start: add "play with app" content
markerikson Mar 30, 2020
deebd28
Quick Start: create nested folder and rename file
markerikson Mar 30, 2020
c58d44f
Store setup
markerikson Mar 30, 2020
fcb618d
Quick Start: add slice, reducer, immutability, and thunk sections
markerikson Mar 31, 2020
072a1cc
Quick start: Add React-Redux section
markerikson Mar 31, 2020
b2114ba
Quick start: emphasize immutability, highlight JSX
markerikson Mar 31, 2020
44dfab0
Tweak "know more?" and explanation styles
markerikson Mar 31, 2020
c7ed4c6
Fix typo and add thunk usage mention
markerikson Mar 31, 2020
c8671fa
Bump Docusaurus to alpha.50
markerikson Apr 5, 2020
da4b3eb
Temporarily rename files to .md to work around DS bug
markerikson Apr 5, 2020
0a98572
Add border color for highlight lines
markerikson Apr 10, 2020
2cd2173
Add code block titles and test line highlights
markerikson Apr 10, 2020
b9712d8
Initial project setup section
markerikson Apr 10, 2020
381810f
Add reducer and data flow explanations
markerikson Apr 10, 2020
7f05fba
Tweak wording
markerikson Apr 19, 2020
3c32808
Link example repo and sandbox
markerikson May 3, 2020
d47a38c
Update Docusaurus
markerikson May 3, 2020
d9bad00
Fill out "Basic Data Flow" page
markerikson May 3, 2020
c6b8500
Add additional phrasing
markerikson May 4, 2020
b3476d4
Add intro and summary content for part 3
markerikson May 4, 2020
80eddd7
Shrink code block file header padding
markerikson May 29, 2020
16773b3
Finish writing Part 3
markerikson May 29, 2020
e6a65a7
Link to Immer docs
markerikson May 29, 2020
ed38f62
Add initial Part 4 content
markerikson Jun 14, 2020
ff02396
Finish Quick Start part 4
markerikson Jun 19, 2020
87c4edd
Remove unnecessary uses of "just"
markerikson Jun 19, 2020
2a04314
Add Part 5 outline
markerikson Jun 28, 2020
1270b67
Update page titles
markerikson Jun 28, 2020
d8dbd4a
Half of part 5
markerikson Jun 28, 2020
91c2fb6
Finish Quick Start content. Yay!!!!!!
markerikson Jun 28, 2020
4e48ac5
Clean up tutorial part 1 based on review feedback
markerikson Jul 11, 2020
47bdf95
Add "What You've Learned" to part 1
markerikson Jul 11, 2020
f06c8e5
Rename part 5 -> 6
markerikson Jul 11, 2020
9eb4374
Rename part 4 -> 5
markerikson Jul 11, 2020
ecdb7f8
Rename part 3 -> 4
markerikson Jul 11, 2020
7ef37ca
Rename part 2 -> 3
markerikson Jul 11, 2020
606cc40
Add new Part 2
markerikson Jul 11, 2020
5067734
Fix up TODO comments and broken links
markerikson Jul 11, 2020
cd52472
Swap to new dataflow diagram
markerikson Jul 12, 2020
1fb3eaa
Assorted edits and link fixes
markerikson Jul 12, 2020
d44fd67
Rename "Quick Start" to "Redux Essentials"
markerikson Jul 13, 2020
f911c7f
Fix links and rename images
markerikson Jul 13, 2020
a53fb7a
Update example app repo/sandbox links
markerikson Jul 13, 2020
cd14e03
Clarify random seed behavior
markerikson Jul 13, 2020
002e69a
Rework introduction content
markerikson Jul 13, 2020
6a7bc5a
Merge branch 'master' into docs/create-quick-start-take-2
markerikson Jul 13, 2020
974553e
Remove unwanted colors from pagination buttons
markerikson Jul 13, 2020
e3cf2c6
Emphasize recommended tutorial
markerikson Jul 13, 2020
85a811e
Clean up README
markerikson Jul 13, 2020
9604ad3
Fix PR preview redirect
markerikson Jul 13, 2020
9fe04c4
Clarify "smallest amount" wording
markerikson Jul 13, 2020
16fcb8f
Try to fix redirects
markerikson Jul 13, 2020
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
15 changes: 15 additions & 0 deletions docs/components/DetailedExplanation.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import React from 'react'

export const DetailedExplanation = ({
children,
title = 'Detailed Explanation'
}) => {
return (
<details className="detailed-explanation">
<summary>
<h4>{title}</h4>
</summary>
{children}
</details>
)
}
522 changes: 522 additions & 0 deletions docs/tutorials/quick-start/quick-start-part-1.mdx

Large diffs are not rendered by default.

11 changes: 11 additions & 0 deletions docs/tutorials/quick-start/quick-start-part-2.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
id: quick-start-part-2
title: Redux Quick Start - Part 2
sidebar_label: 'Building a Redux App'
hide_title: true
description: The official Quick Start tutorial for Redux - the fastest way to learn and start using Redux today!
---

import { DetailedExplanation } from '../../components/DetailedExplanation'

# Quick Start, Part 2: Building a React + Redux App
1,420 changes: 754 additions & 666 deletions website/package-lock.json

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
"deploy": "docusaurus deploy"
},
"dependencies": {
"@docusaurus/core": "2.0.0-alpha.43",
"@docusaurus/preset-classic": "2.0.0-alpha.43",
"@docusaurus/core": "2.0.0-alpha.48",
"@docusaurus/preset-classic": "2.0.0-alpha.48",
"classnames": "2.2.6",
"react": "16.13.0",
"react-dom": "16.13.0"
Expand Down
52 changes: 35 additions & 17 deletions website/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,23 +11,41 @@ module.exports = {
'introduction/ecosystem',
'introduction/examples'
],
'Basic Tutorial': [
'basics/basic-tutorial',
'basics/actions',
'basics/reducers',
'basics/store',
'basics/data-flow',
'basics/usage-with-react',
'basics/example'
],
'Advanced Tutorial': [
'advanced/advanced-tutorial',
'advanced/async-actions',
'advanced/async-flow',
'advanced/middleware',
'advanced/usage-with-react-router',
'advanced/example-reddit-api',
'advanced/next-steps'
Tutorials: [
{
type: 'category',
label: 'Quick Start',
items: [
'tutorials/quick-start/quick-start-part-1',
'tutorials/quick-start/quick-start-part-2'
]
},
{
type: 'category',
label: 'Basic Tutorial',
items: [
'basics/basic-tutorial',
'basics/actions',
'basics/reducers',
'basics/store',
'basics/data-flow',
'basics/usage-with-react',
'basics/example'
]
},
{
type: 'category',
label: 'Advanced Tutorial',
items: [
'advanced/advanced-tutorial',
'advanced/async-actions',
'advanced/async-flow',
'advanced/middleware',
'advanced/usage-with-react-router',
'advanced/example-reddit-api',
'advanced/next-steps'
]
}
],
Recipes: [
'recipes/recipe-index',
Expand Down
126 changes: 119 additions & 7 deletions website/src/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
/**
* Any CSS included here will be global. The classic template
* bundles Infima by default. Infima is a CSS framework designed to
* work well for content-centric websites.
*/
/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #764abc;
--ifm-color-primary-dark: #6a43a9;
Expand All @@ -8,29 +14,95 @@
--ifm-color-primary-lightest: #9f80d0;

--ifm-code-font-size: 95%;
--ifm-code-border-radius: 3px;
--ifm-code-background: rgba(27, 31, 35, 0.05);
--ifm-blockquote-color: #ecf4f9;
--ifm-blockquote-color-dark: #cbddea;

--ifm-code-padding-vertical: 0.1rem;
--ifm-code-padding-horizontal: 0.2rem;
--ifm-pre-background: rgb(39, 40, 34);

--ifm-alert-color: black;

--ra-admonition-color: #ecf4f9;
--ra-admonition-color-dark: #2a98b9;

--ra-admonition-color-important: #2a98b9;

--ra-admonition-color-success: #f1fdf9;
--ra-admonition-color-success-dark: #00bf88;

--ra-admonition-color-caution: #fffbf5;
--ra-admonition-color-caution-dark: #f0ad4e;

--ra-admonition-color-error: #fff2f2;
--ra-admonition-color-error-dark: #d9534f;

--ra-admonition-icon-color: black !important;
}

@media screen and (max-width: 996px) {
:root {
--ifm-font-size-base: 15px;
}
}
@media screen and (min-width: 997px) {
:root {
--ifm-font-size-base: 17px;
}
}
blockquote {
color: var(--ifm-font-base-color);
background-color: var(--ifm-blockquote-color);
border-left: 6px solid var(--ifm-blockquote-color-dark);
border-radius: var(--ifm-global-radius);
}

.docusaurus-highlight-code-line {
background-color: rgb(72, 77, 91);
display: block;
margin: 0 calc(-1 * var(--ifm-pre-padding));
padding: 0 var(--ifm-pre-padding);
}
code {
background-color: var(--ifm-color-emphasis-300);
border-radius: 0.2rem;
}

a code {
a code,
code a {
color: inherit;
}

a.contents__link > code {
color: inherit;
}

a.contents__link.contents__link--active {
font-weight: 600;
}

a:visited {
color: var(--ifm-color-primary);
}

.pagination-nav .pagination-nav__link {
transition: all 0.2s ease;
border-color: var(--ifm-color-primary);
}
.pagination-nav__link .pagination-nav__link--label {
color: var(--ifm-color-primary);
}
.pagination-nav__link:hover {
background: var(--ifm-color-primary);
color: white;
}

.pagination-nav__link:hover * {
color: white;
}

.navbar .navbar__items {
flex: 1 1 auto;
}
Expand Down Expand Up @@ -73,24 +145,28 @@ a code {
overflow: hidden;
}

.style-guide details {
.style-guide details,
details.detailed-explanation {
background-color: var(--ifm-blockquote-color);
margin: 1rem 0;
padding: 1rem;
margin: 0.25rem 0;
padding: 0.25rem 0.5rem;
border-radius: var(--ifm-global-radius);
}

.style-guide details summary {
.style-guide details summary,
details.detailed-explanation summary {
cursor: pointer;
}

.style-guide details summary h4 {
.style-guide details summary h4,
details.detailed-explanation summary h4 {
display: inline-block;
margin-top: 0;
margin-bottom: 0;
}

.style-guide details p {
.style-guide details p,
details.detailed-explanation p {
margin-bottom: 0;
}

Expand All @@ -114,3 +190,39 @@ a code {
content: ' RECOMMENDED';
color: #2b5a99;
}

.admonition {
color: var(--ifm-font-base-color);
border-radius: var(--ifm-global-radius);
border-left: 6px solid var(--ra-admonition-color-dark);
}

.admonition.admonition-note,
.admonition.admonition-info,
.admonition.admonition-important,
.admonition.admonition-secondary {
--ra-admonition-color: #ecf4f9;
background-color: var(--ra-admonition-color);
}

.admonition.admonition-success,
.admonition.admonition-tip {
background-color: var(--ra-admonition-color-success);
border-left-color: var(--ra-admonition-color-success-dark);
}

.admonition.admonition-caution {
background-color: var(--ra-admonition-color-caution);
border-left-color: var(--ra-admonition-color-caution-dark);
}

.admonition.admonition-warning,
.admonition.admonition-danger {
background-color: var(--ra-admonition-color-error);
border-left-color: var(--ra-admonition-color-error-dark);
}

.admonition .admonition-icon svg {
fill: black;
stroke: black;
}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.