Skip to content

reorg Advanced guides #272

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

Merged
merged 12 commits into from
Aug 21, 2020
Merged
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
36 changes: 36 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,39 @@ I thought I should lay out some core principles that we will follow so that this
4. **Add TypeScript Playground Links**: Whenever adding a code example longer than four lines, add a link to the TypeScript Playground with the code. Use the default compiler Playground options.

That's all I've got! Again, really happy you are thinking about helping out, who knows, the person who you might be helping is yourself in future!

## Project structure

- All content is in `/docs`
- the `/docs/basic` is compiled into `README.md` to preserve GitHub readability via GitHub action, thanks
- `/website` consumes the `/docs` content, which is a [Docusaurus 2](https://docusaurus.io/) site, which also has [Algolia search](https://www.algolia.com/) (thanks to both teams for their support!)

The website is deployed to Netlify on swyx's personal account.

To run the docsite locally:

```bash
yarn # install deps
## make sure deps are installed in /website too
cd website && yarn start
```

example output from successful startup

```
yarn run v1.22.4
warning package.json: No license field
$ docusaurus start
Starting the development server...

✔ Client
Compiled successfully in 9.61s

ℹ 「wds」: Project is running at http://localhost:3000/
ℹ 「wds」: webpack output is served from /
ℹ 「wds」: Content not from webpack is served from /Users/wanshawn/Work/react-typescript-cheatsheet/website
ℹ 「wds」: 404s will fallback to /index.html

✔ Client
Compiled successfully in 116.41ms
```
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

<div align="center">

:wave: This repo is maintained by [@swyx](https://twitter.com/swyx), [@ferdaber](https://twitter.com/ferdaber), [@eps1lon](https://twitter.com/sebsilbermann), [@IslamAttrash](https://twitter.com/IslamAttrash), [@jsjoeio](https://twitter.com/jsjoeio) and [@arvindcheenu](https://twitter.com/arvincheenu), we're so happy you want to try out TypeScript with React! If you see anything wrong or missing, please [file an issue](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet/issues/new/choose)! :+1:
:wave: This repo is maintained by [@swyx](https://twitter.com/swyx), [@ferdaber](https://twitter.com/ferdaber), [@eps1lon](https://twitter.com/sebsilbermann), [@jsjoeio](https://twitter.com/jsjoeio) and [@arvindcheenu](https://twitter.com/arvincheenu), we're so happy you want to try out TypeScript with React! If you see anything wrong or missing, please [file an issue](https://github.com/typescript-cheatsheets/react-typescript-cheatsheet/issues/new/choose)! :+1:

</div>

Expand Down
54 changes: 0 additions & 54 deletions docs/advanced/guides/conditionally-rendering.md

This file was deleted.

47 changes: 0 additions & 47 deletions docs/advanced/guides/extract-props.md

This file was deleted.

203 changes: 0 additions & 203 deletions docs/advanced/guides/generic-components.md

This file was deleted.

Loading