Merge pull request #33 from jrdnbradford/gh-round-2

Updates to GitHub pages

.github/CONTRIBUTING.md

@@ -1,5 +1,5 @@
-## How to Contribute
-Contributions and fixes are welcome!
+# How to Contribute
+Contributions, issues, and fixes are welcome!
 
 > If making changes to data, this must be done to the [raw txt files](/data-raw/corpus/). The [`generate_data.R`](/data-raw/generate_data.R) script automates creating the RDA files and accompanying documentation.
 
@@ -8,6 +8,7 @@ Contributions and fixes are welcome!
 1. Install the [`pre-commit` hooks](https://pre-commit.com/#install)
 
 1. Create a new branch
+
     ```bash
     git checkout -b my-branch
     ```
@@ -18,6 +19,7 @@ Contributions and fixes are welcome!
     * Render [`README.md`](/README.md) from [`README.qmd`](/README.md) if you made changes to the `README`
 
 1. Ensure all {[`testthat`](https://testthat.r-lib.org/)} tests pass
+
     ```R
     devtools::test()
     ```

.github/workflows/pkgdown.yaml

@@ -2,9 +2,9 @@
 # Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
 on:
   push:
-    branches: [main, master]
+    branches: [main]
   pull_request:
-    branches: [main, master]
+    branches: [main]
   release:
     types: [published]
   workflow_dispatch:

README.md

@@ -22,20 +22,21 @@ Call of Cthulhu*
 
 {`lovecraftr`} contains H. P. Lovecraft’s corpus as R datasets for
 textual analysis. This repository contains both the raw txt files and
-RDA files. See [H. P. Lovecraft Datasets](#h-p-lovecraft-datasets) below
+RDA files. See the
+[reference](https://jrdnbradford.github.io/lovecraftr/reference/index.html)
 for the list of available works.
 
 ## Installation
 
 Install from [GitHub](https://github.com/jrdnbradford/lovecraftr/) using
-{[devtools](https://devtools.r-lib.org/)}:
+{[`devtools`](https://devtools.r-lib.org/)}:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github("jrdnbradford/lovecraftr")
 ```
 
-or {[remotes](https://remotes.r-lib.org//)}:
+or {[`remotes`](https://remotes.r-lib.org//)}:
 
 ``` r
 # install.packages("remotes")

README.qmd

@@ -22,19 +22,21 @@ knitr::opts_chunk$set(
 
 -[H. P. Lovecraft](https://en.wikipedia.org/wiki/H._P._Lovecraft), *The Call of Cthulhu*
 
-{`lovecraftr`} contains H. P. Lovecraft's corpus as R datasets for textual analysis. This repository contains both the raw txt files and RDA files. See [H. P. Lovecraft Datasets](#h-p-lovecraft-datasets) below for the list of available works.
+{`lovecraftr`} contains H. P. Lovecraft's corpus as R datasets for textual analysis. This repository contains both the raw txt files and RDA files. See the [reference](https://jrdnbradford.github.io/lovecraftr/reference/index.html) for the list of available works.
 
 ## Installation
 
 ```{R load-package, echo=FALSE}
 devtools::load_all()
 ```
-Install from [GitHub](https://github.com/jrdnbradford/lovecraftr/) using {[devtools](https://devtools.r-lib.org/)}:
+
+Install from [GitHub](https://github.com/jrdnbradford/lovecraftr/) using {[`devtools`](https://devtools.r-lib.org/)}:
 ```{R devtools-install, echo=TRUE, eval=FALSE, output=FALSE}
 # install.packages("devtools")
 devtools::install_github("jrdnbradford/lovecraftr")
 ```
-or {[remotes](https://remotes.r-lib.org//)}:
+
+or {[`remotes`](https://remotes.r-lib.org//)}:
 ```{R remotes-install, echo=TRUE, eval=FALSE, output=FALSE}
 # install.packages("remotes")
 remotes::install_github("jrdnbradford/lovecraftr")
@@ -47,6 +49,7 @@ Character vectors of individual works can be accessed in several ways:
 cthulhu <- lovecraftr::the_call_of_cthulhu
 head(cthulhu)
 ```
+
 or
 ```{R data-cthulhu, echo=TRUE, eval=FALSE}
 data("the_call_of_cthulhu")
@@ -60,6 +63,7 @@ corpus |>
   dplyr::filter(title == "THE CALL OF CTHULHU") |>
   head()
 ```
+
 or
 ```{R data-lovecraft, echo=TRUE, eval=FALSE}
 data("lovecraft")
@@ -76,7 +80,6 @@ MIT. See [LICENSE.md](/LICENSE.md).
 ## Citation
 
 Please cite this package if you use it.
-
 ```{R citation, echo=TRUE, eval=TRUE}
 citation("lovecraftr")
 ```