created customized reference page, updated vignette and README

DESCRIPTION

@@ -5,7 +5,11 @@ Authors@R: c(
     person("Mian", "Zhong", , "[email protected]", role = c("aut", "cre"),
            comment = c(ORCID = "0009-0009-4546-7214")),
     person("Margaux", "Götschmann", , "[email protected]", role = "aut",
-           comment = c(ORCID = "0009-0002-2567-3343"))
+           comment = c(ORCID = "0009-0002-2567-3343")),
+    person("Colin", "Walder", , "[email protected]", role = "aut",
+           comment = c(ORCID = "0009-0006-0969-1954")),
+    person("Lars", "Schöbitz", , "[email protected]", role = "aut",
+           comment = c(ORCID = "0000-0003-2196-5015"))
   )
 Description: A set of automation tools to set up an openwashdata data package in a consistent structure. It helps to reduce manual entries on tidy data exporting, README writing, pkgdown configuration and content, and etc.
 License: MIT + file LICENSE

README.Rmd

@@ -19,17 +19,19 @@ knitr::opts_chunk$set(
 [![R-CMD-check](https://github.com/openwashdata-dev/washr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata-dev/washr/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-The goal of washr is to provide tools to make [openwashdata data package](https://openwashdata.org/pages/gallery/data/) workflow consistent and efficient.
+The goal of `washr` is to provide tools to make the [openwashdata data package](https://openwashdata.org/pages/gallery/data/) workflow consistent and efficient.
 
 ## Installation
 
-You can install the development version of washr from [GitHub](https://github.com/) with:
+In the near future, we're planning to release `washr` on CRAN. For now, you can install the development version from [GitHub](https://github.com/) with:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github("openwashdata-dev/washr")
 ```
 
-## Workflow
+## How to use washr
 
-To learn more, please refer to the detailed vignette: .
+To learn more about `washr`, check out the 'Get Started' page. This, along with the 'Reference' page, will give you a good overview of `washr`'s current capabilities and limitations.
+
+If you decide to use `washr` for publishing your data (which we hope you will!), take a look at our detailed manual. It's regularly updated and walks you through the entire process step-by-step. The manual is your best bet for the most up-to-date information, as we're constantly improving it.

README.md

@@ -8,20 +8,29 @@
 [![R-CMD-check](https://github.com/openwashdata-dev/washr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata-dev/washr/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
-The goal of washr is to provide tools to make [openwashdata data
+The goal of `washr` is to provide tools to make the [openwashdata data
 package](https://openwashdata.org/pages/gallery/data/) workflow
 consistent and efficient.
 
 ## Installation
 
-You can install the development version of washr from
+In the near future, we’re planning to release `washr` on CRAN. For now,
+you can install the development version from
 [GitHub](https://github.com/) with:
 
 ``` r
 # install.packages("devtools")
 devtools::install_github("openwashdata-dev/washr")
 ```
 
-## Workflow
+## How to use washr
 
-To learn more, please refer to the detailed vignette: .
+To learn more about `washr`, check out the ‘Get Started’ page. This,
+along with the ‘Reference’ page, will give you a good overview of
+`washr`’s current capabilities and limitations.
+
+If you decide to use `washr` for publishing your data (which we hope you
+will!), take a look at our detailed manual. It’s regularly updated and
+walks you through the entire process step-by-step. The manual is your
+best bet for the most up-to-date information, as we’re constantly
+improving it.

docs/pkgdown.yml

@@ -4,3 +4,25 @@ pkgdown_sha: ~
 articles:
   washr-get-started: washr-get-started.html
 last_built: 2024-09-20T11:38Z
+
+reference:
+- title: "Getting started"
+  contents:
+  - setup_rawdata
+- title: "Documenting your data"
+  desc: "Helper functions to document both your dataset(s) and functions"
+  contents:
+  - setup_dictionary
+  - fill_dictionary
+  - setup_roxygen
+  - generate_roxygen_docs
+- title: "Adding metadata"
+  desc: "Helper functions to add metadata"
+  contents:
+  - add_citation
+  - update_description
+- title: "Publishing your data"
+  desc: "Helper functions to communicate your data"
+  contents:
+  - setup_readme
+  - setup_website