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

Update intermission.md including a caution block to let the reader know not to look for a Typescript version #8885

Merged
merged 5 commits into from
Jul 13, 2023

Conversation

jgal1
Copy link
Contributor

@jgal1 jgal1 commented Jul 11, 2023

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!

…ow not to look for a Typescript version.

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!
@jtoar jtoar changed the title Update intermission.md including a caution block to let the reader kn… Update intermission.md including a caution block to let the reader know not to look for a Typescript version. Jul 12, 2023
@jtoar jtoar changed the title Update intermission.md including a caution block to let the reader know not to look for a Typescript version. Update intermission.md including a caution block to let the reader know not to look for a Typescript version Jul 12, 2023
Copy link
Contributor

@jtoar jtoar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @jgal1, made a few small edits, let me know what you think.

docs/docs/tutorial/intermission.md Outdated Show resolved Hide resolved
@jtoar jtoar added this to the next-release milestone Jul 12, 2023
@jtoar jtoar added the release:docs This PR only updates docs label Jul 12, 2023
@jgal1
Copy link
Contributor Author

jgal1 commented Jul 12, 2023

Thanks @jtoar , yeah I risked it and didn't actually test the markdown rendering sorry about that and thanks for fixing!

@jtoar jtoar merged commit 97f1f10 into redwoodjs:main Jul 13, 2023
@jgal1 jgal1 deleted the patch-1 branch July 13, 2023 22:56
@jtoar jtoar modified the milestones: next-release, v6.0.0 Jul 17, 2023
jtoar added a commit that referenced this pull request Jul 17, 2023
…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 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:docs This PR only updates docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants