Skip to content

Commit fdd3845

Browse files
committed
added tutorials section
resolved #59
1 parent 9b3e4d8 commit fdd3845

File tree

7 files changed

+30
-23
lines changed

7 files changed

+30
-23
lines changed

README.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,9 @@ You should check Playground Project located in the `/playground` folder. It is a
5252
- [Vendor Types Augmentation](#vendor-types-augmentation)
5353
- [Default and Named Module Exports](#default-and-named-module-exports)
5454
- [FAQ](#faq)
55-
- [Roadmap](#roadmap)
5655
- [Contribution Guide](#contribution-guide)
5756
- [Project Examples](#project-examples)
57+
- [Tutorials](#tutorials)
5858

5959
---
6060

@@ -1419,12 +1419,6 @@ class StatefulCounter extends React.Component<Props, State> {
14191419
14201420
---
14211421
1422-
# Roadmap
1423-
- extend HOC section with more advanced examples [#5](../../issues/5)
1424-
- investigate typing patterns for generic component children [#7](../../issues/7)
1425-
1426-
[⇧ back to top](#table-of-contents)
1427-
14281422
# Contribution Guide
14291423
- Don't edit `README.md` - it is built with `generator` script from separate `.md` files located in the `/docs/markdown` folder, edit them instead
14301424
- For code snippets, they are also injected by `generator` script from the source files located in the playground folder (this step make sure all examples are type-checked and linted), edit them instead
@@ -1446,8 +1440,18 @@ node ./generator/bin/generate-readme.js
14461440
14471441
[⇧ back to top](#table-of-contents)
14481442
1443+
---
1444+
14491445
# Project Examples
14501446
14511447
https://github.com/piotrwitek/react-redux-typescript-webpack-starter
14521448
14531449
[⇧ back to top](#table-of-contents)
1450+
1451+
# Tutorials
1452+
> Curated list of relevant in-depth tutorials
1453+
1454+
Higher-Order Components:
1455+
- https://medium.com/@jrwebdev/react-higher-order-component-patterns-in-typescript-42278f7590fb
1456+
1457+
[⇧ back to top](#table-of-contents)

docs/markdown/6_end.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,3 @@
1-
# Roadmap
2-
- extend HOC section with more advanced examples [#5](../../issues/5)
3-
- investigate typing patterns for generic component children [#7](../../issues/7)
4-
5-
[⇧ back to top](#table-of-contents)
6-
71
# Contribution Guide
82
- Don't edit `README.md` - it is built with `generator` script from separate `.md` files located in the `/docs/markdown` folder, edit them instead
93
- For code snippets, they are also injected by `generator` script from the source files located in the playground folder (this step make sure all examples are type-checked and linted), edit them instead
@@ -24,9 +18,3 @@ node ./generator/bin/generate-readme.js
2418
```
2519

2620
[⇧ back to top](#table-of-contents)
27-
28-
# Project Examples
29-
30-
https://github.com/piotrwitek/react-redux-typescript-webpack-starter
31-
32-
[⇧ back to top](#table-of-contents)

docs/markdown/7_links.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Project Examples
2+
3+
https://github.com/piotrwitek/react-redux-typescript-webpack-starter
4+
5+
[⇧ back to top](#table-of-contents)
6+
7+
# Tutorials
8+
> Curated list of relevant in-depth tutorials
9+
10+
Higher-Order Components:
11+
- https://medium.com/@jrwebdev/react-higher-order-component-patterns-in-typescript-42278f7590fb
12+
13+
[⇧ back to top](#table-of-contents)

docs/markdown/_toc.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@
2727
- [Vendor Types Augmentation](#vendor-types-augmentation)
2828
- [Default and Named Module Exports](#default-and-named-module-exports)
2929
- [FAQ](#faq)
30-
- [Roadmap](#roadmap)
3130
- [Contribution Guide](#contribution-guide)
3231
- [Project Examples](#project-examples)
32+
- [Tutorials](#tutorials)

generator/bin/generate-readme.js

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

generator/bin/generate-readme.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

generator/src/generate-readme.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ const inputFiles = [
1313
DOCS_PATH + '3_tools.md',
1414
DOCS_PATH + '4_recipes.md',
1515
DOCS_PATH + '5_faq.md',
16-
DOCS_PATH + '6_end.md'
16+
DOCS_PATH + '6_end.md',
17+
DOCS_PATH + '7_links.md',
1718
];
1819

1920
const outputFile = TOP_LEVEL_PATH + 'README.md';

0 commit comments

Comments
 (0)