Skip to content

Commit e2c9598

Browse files
davidkane9claude
andcommitted
Rename the Tutorials tutorial to Getting Started
Existing screenshots across the course materials show Getting Started as the tutorial.helpers tutorial name, so the five-minute first-contact tutorial takes that name (id: getting-started). Not a rollback: the content is unchanged - student info, one bash CP/CR, download. The download filename mention and README run_tutorial() example updated. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent e6189ef commit e2c9598

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.Rmd

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ There are three exported functions for checking the tutorials in your package. S
5656
The package includes the "Getting Started" tutorial, which uses VS Code on GitHub Codespaces. You should require your students to complete it if you are creating your own tutorials with the **tutorial.helpers** package. Have students run:
5757

5858
````
59-
learnr::run_tutorial("tutorials", package = "tutorial.helpers")
59+
learnr::run_tutorial("getting-started", package = "tutorial.helpers")
6060
````
6161

6262
This will teach them enough about how tutorials work to be able to complete the tutorials you write.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ on GitHub Codespaces. You should require your students to complete it if
6464
you are creating your own tutorials with the **tutorial.helpers**
6565
package. Have students run:
6666

67-
learnr::run_tutorial("tutorials", package = "tutorial.helpers")
67+
learnr::run_tutorial("getting-started", package = "tutorial.helpers")
6868

6969
This will teach them enough about how tutorials work to be able to
7070
complete the tutorials you write.

inst/tutorials/tutorials/tutorial.Rmd renamed to inst/tutorials/getting-started/tutorial.Rmd

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Tutorials
2+
title: Getting Started
33
author: David Kane
44
tutorial:
5-
id: tutorials
5+
id: getting-started
66
output:
77
learnr::tutorial:
88
progressive: yes
@@ -93,7 +93,7 @@ At the end of every tutorial, you will download a copy of your answers. We will
9393

9494
Make sure to answer the question about how many **minutes** you spent on the tutorial and to click "Submit Answer."
9595

96-
After clicking the "Download" button, you will be prompted to save a file named `tutorials_answers.html`. By default, this file will be saved in the `Downloads` folder on your computer. This action only downloads the file; it does not send the file to anyone.
96+
After clicking the "Download" button, you will be prompted to save a file named `getting-started_answers.html`. By default, this file will be saved in the `Downloads` folder on your computer. This action only downloads the file; it does not send the file to anyone.
9797

9898
Unless your instructor tells you otherwise, you should use the default file name, which will usually be of the form `short-name-of-tutorial` + `_answers` + `.html`.
9999

tests/testthat/test-write_answers.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
# devtools::install()
1818
#
1919
# Save a fresh fixture from the live tutorial
20-
# 5) Launch the tutorials tutorial and answer a few questions
20+
# 5) Launch the getting-started tutorial and answer a few questions
2121
# including at least one multi-line answer.
2222
# 6) Temporarily add these two lines inside the downloadHandler content
2323
# function in submission_server(), just before write_answers(file, session):

0 commit comments

Comments
 (0)