Skip to content

Commit

Permalink
docs(sessions): 📝 learning objectives for website creation (#27)
Browse files Browse the repository at this point in the history
* Update with introduction

* docs(sessions): 📝 revise learning objectives of website session

---------

Co-authored-by: Luke W. Johnston <[email protected]>
  • Loading branch information
omarsilverman and lwjohnst86 authored Oct 16, 2024
1 parent 709bd7b commit 20b3bf0
Showing 1 changed file with 24 additions and 16 deletions.
40 changes: 24 additions & 16 deletions sessions/creating-website.qmd
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
# Exposing your package to the world with a website:
# Exposing your package to the world with a website

{{< include ../includes/_wip.qmd >}}

```{r setup}
#| include: false
```

<!-- TODO: Add an introduction here -->
## Learning objectives

- Setting up a website (with pkgdown)
- Customizing the themes
- Getting all resources and material organized
- Defining lifecycle of your package and individual functions (with
lifecycle)
The overall **learning outcome** for this session is:

**Session objectives**:
1. Explain the main benefits to creating a website for your package,
describe items that are useful to communicate to (potential) users,
and use the `{pkgdown}` package to auto-generate a website for you
whenever changes are made.

- Describe the functionality `pkgdown` provides to deploy a website
for package documentation and then learn to use pkgdown to deploy a
website
- Customize the website with pre-existing themes
- Organize the website with vignettes, tutorials and custom pages
- Explain a functions' lifecycle process and the tools to handle it in
R
Specific **objectives** are:

1. Identify and list some benefits of using a website to communicate
details about your package.
2. Describe the differences between a locally created website and a
website hosted on a server.
3. Use `{pkgdown}` to generate HTML files structured as a website based
on your vignettes and function documentation.
4. Create an aesthetically pleasing (to you) website using the themes
in `{pkgdown}`.
5. Use the `{lifecycle}` package to communicate the developmental
maturity of your package and of individual functions, in a way that
also gets included on the website.
6. Explain the benefit to having your website automatically generated
whenever changes are made and use `{usethis}` and GitHub Action
workflows to setup up this auto-generation.

## TODO: Section

Expand Down Expand Up @@ -79,4 +87,4 @@ TODO: Reading text

## Summary

- TODO: List of summary items
- TODO: List of summary items

0 comments on commit 20b3bf0

Please sign in to comment.