Skip to content

Commit

Permalink
chore(sync): 🔨 synced local '_extensions/rostools/r3-theme/' with rem…
Browse files Browse the repository at this point in the history
…ote '_extensions/r3-theme/'
  • Loading branch information
lwjohnst86 committed Feb 14, 2025
1 parent d57b996 commit 3f2b082
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 2 deletions.
19 changes: 19 additions & 0 deletions _extensions/rostools/r3-theme/includes/reading-website-r.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
We will explain this a bit during the course, but read this to start
learning how the website is structured and how to read certain things.
Specifically, there are a few "syntax" type formatting of the text in
this website to be aware of:

- Folder names always end with a `/`, for example `data/` means the
data folder.
- File names always end with their file extension, for example `content.md`
means the file is a Markdown file.
- R variables are always shown as is. For instance, for the code
`x <- 10`, `x` is a variable because it was assigned with 10.
- Functions always end with `()`, for instance `mean()` or
`read_csv()`.
- Sometimes functions have their package name appended with `::` to
indicate to run the code from the specific package, since we likely
haven't loaded the package with `library()`. For instance, to
install packages from GitHub using the `{pak}` package we use
`pak::pkg_install("user/packagename")`. You'll learn about this more
later.
9 changes: 9 additions & 0 deletions _extensions/rostools/r3-theme/includes/reading-website.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
We will explain this a bit during the lessons, but read this to start
learning how the website is structured and how to read certain things.
Specifically, there are a few "syntax" type formatting of the text in
this website to be aware of:

- Folder names always end with a `/`, for example `data/` means the
data folder.
- File names always end with their file extension, for example `content.md`
means the file is a Markdown file.
4 changes: 2 additions & 2 deletions _extensions/rostools/r3-theme/text-snippet.lua
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ computer to indicate this to the instructor :womans_hat: :tophat:
]]

local faq_text = [[
Throughout the many times we've taught this tutorial and others, we
Throughout the many times we've taught this course and others, we
get asked a lot of questions. We have a [Frequently Asked
Questions](https://guides.rostools.org/faq) page for keeping track of
some of these questions. Check out this page, maybe your question has
Expand Down Expand Up @@ -55,7 +55,7 @@ a code chunk. The code below also includes the code from the exercises.
]]

local discord_text = [[
If you want to get help virtually or after the tutorial, you can join the
If you want to get help virtually or after the course, you can join the
[Discord channel](https://discord.gg/WKyTF5yXBJ) where you can ask questions
in the `questions-or-advice` text channel.
]]
Expand Down

0 comments on commit 3f2b082

Please sign in to comment.