Skip to content

Commit

Permalink
Update intermission.md including a caution block to let the reader kn…
Browse files Browse the repository at this point in the history
…ow not to look for a Typescript version (#8885)

I'm a first-time Redwood user. While working through the tutorial, once
I hit the intermission and started working through the examples, I
realized cloning the tutorial repo with the default instructions
contained js-only code. Since the tutorial provided example snippets in
Typescript, I figured there must be a separate branch or way to download
a typescript version. After poking around, I found this open issue
redwoodjs/redwood-tutorial#56 and realized
this was in progress, so this just edits the documentation to save other
readers time while working through the tutorial. I'm no copywriter, and
the tutorial seems to take a specific tone, so please feel free to edit
the copy or make suggestions (i.e. link to the github issue in the
comment so people can track it) I didn't include the issue since there
doesn't seem to be a precedent for doing so in the rest of the
documentation. Using Redwood for the first time has been a great
experience by the way!

---------

Co-authored-by: Dominic Saadi <dominiceliassaadi@gmail.com>
  • Loading branch information
jgal1 and jtoar committed Jul 17, 2023
1 parent 6221b2a commit 2cf2526
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/docs/tutorial/intermission.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,12 @@ yarn rw dev

If you haven't been through the first tutorial, or maybe you went through it on an older version of Redwood (anything pre-0.41) you can clone [this repo](https://github.com/redwoodjs/redwood-tutorial) which contains everything built so far and also adds a little styling so it isn't quite so...tough to look at. The example repo includes [TailwindCSS](https://tailwindcss.com) to style things up and adds a `<div>` or two to give us some additional hooks to hang styling on.

:::caution The TypeScript version of the Example Repo is currently in progress

If you want to complete the tutorial in TypeScript, continue with your own repo, making any necessary edits. Don't worry, the remainder of the tutorial continues to offer both TypeScript and JavaScript example code changes.

:::

```bash
git clone https://github.com/redwoodjs/redwood-tutorial
cd redwood-tutorial
Expand Down

0 comments on commit 2cf2526

Please sign in to comment.