Merge pull request #68 from r-devel/style-updates

A few style updates!
r-devel · Nov 15, 2024 · a05aaed · a05aaed
2 parents b8004f5 + 25475f5
commit a05aaed
Show file tree

Hide file tree

Showing 7 changed files with 50 additions and 24 deletions.
diff --git a/CRAN Cookbook Hex Sticker.png b/CRAN Cookbook Hex Sticker.png
diff --git a/_freeze/preface/execute-results/html.json b/_freeze/preface/execute-results/html.json
@@ -1,8 +1,8 @@
 {
-  "hash": "293c910c7cd0ac1ff3a83c02c6abe6fa",
+  "hash": "f9cbdfb2ea1357a08f4d5198bb024916",
   "result": {
     "engine": "knitr",
-    "markdown": "---\ntitle: \"Preface\"\nsubtitle: \"\"\nformat: \n  html:\n    css: style.css\n---\n\n\n\n\n\n# Motivation\n\n<!-- add this --> \n\n# Introduction\n\nThe CRAN Cookbook has been developed as part of a special project grant from the R Consortium in 2024. The proposal is titled: **Improving the Skills of R Package Maintainers**. The goals of the project are:\n\n1. Educate a diverse cohort of young R developers to acquire the technical knowledge and skills required to participate in the continuous integration of R packages into the R ecosystem.\n2. Develop a new documentation solution with a Quarto website that is user-friendly for new R package maintainers on CRAN.\n3. Identify common CRAN submission issues and create a framework of \"problems\" and \"solutions\" that are easy to implement and discover.\n\n<!-- add more -->\n\n# Prerequisite\n\n- **Beginner to intermediate knowledge of R Programming**: This guide is designed to assist both first-time R package maintainers and those with experience who prefer to navigate a curated selection of the most common issues encountered when submitting to CRAN, as identified by CRAN Maintainers. It provides a 'best practices' approach to resolving R package issues to facilitate a successful re-submission to CRAN.\n\n\n- While not required, it's useful to have experience in debugging code. Submitting your R package to CRAN is a multi-step process that may involve communicating with multiple CRAN volunteers and updating your code, tests, examples, documentation, and other supplementary files to meet acceptance criteria. Developing strong debugging skills can be particularly valuable during this process, as it can help you effectively apply the examples in this cookbook to create custom solutions for updating your R package.\n\n\n# Acknowledgement\n\n- Thank you to the [R Consortium](https://www.r-consortium.org/) for funding and sponsoring this project!\n\n![](https://raw.githubusercontent.com/RConsortium/artwork/main/r_consortium/R_Consortium-logo-horizontal-color.svg){fig-align=\"left\"}\n\n## Contributors\n\n_Thanks to all contributors!_\n\n- Lluís Revilla ([@llrs](https://github.com/llrs))\n\n- Ivan Krylov ([@aitap](https://github.com/aitap))\n\n# Colophon\n\nThis cookbook is a Quarto website. To learn more about Quarto websites visit <https://quarto.org/docs/websites>. The cookbook is hosted on GitHub pages as part of the [Community R development resources](https://github.com/r-devel). The website is currently deployed with [local commands](https://github.com/r-devel/cran-cookbook/wiki/GitHub-Pages-Deployment).\n\n### Session info \n\n\n\n\n\n::: {.cell}\n\n```{.r .cell-code}\nif (!requireNamespace(\"devtools\", quietly = TRUE)) {\n    install.packages(\"devtools\")\n}\nlibrary(devtools)\n```\n\n::: {.cell-output .cell-output-stderr}\n\n```\nLoading required package: usethis\n```\n\n\n:::\n\n```{.r .cell-code}\ndevtools::session_info()\n```\n\n::: {.cell-output .cell-output-stdout}\n\n```\n─ Session info ───────────────────────────────────────────────────────────────\n setting  value\n version  R version 4.4.1 (2024-06-14 ucrt)\n os       Windows 10 x64 (build 19045)\n system   x86_64, mingw32\n ui       RTerm\n language (EN)\n collate  German_Austria.utf8\n ctype    German_Austria.utf8\n tz       Europe/Vienna\n date     2024-11-08\n pandoc   3.2 @ C:/Program Files/RStudio/resources/app/bin/quarto/bin/tools/ (via rmarkdown)\n\n─ Packages ───────────────────────────────────────────────────────────────────\n ! package     * version date (UTC) lib source\n P cachem        1.1.0   2024-05-16 [?] RSPM (R 4.4.0)\n P cli           3.6.3   2024-06-21 [?] RSPM (R 4.4.0)\n P devtools    * 2.4.5   2022-10-11 [?] RSPM (R 4.4.0)\n P digest        0.6.37  2024-08-19 [?] RSPM (R 4.4.0)\n P ellipsis      0.3.2   2021-04-29 [?] RSPM (R 4.4.0)\n P evaluate      1.0.0   2024-09-17 [?] RSPM (R 4.4.0)\n P fastmap       1.2.0   2024-05-15 [?] RSPM (R 4.4.0)\n P fs            1.6.4   2024-04-25 [?] RSPM (R 4.4.0)\n P glue          1.8.0   2024-09-30 [?] RSPM (R 4.4.0)\n P htmltools     0.5.8.1 2024-04-04 [?] RSPM (R 4.4.0)\n P htmlwidgets   1.6.4   2023-12-06 [?] RSPM (R 4.4.0)\n P httpuv        1.6.15  2024-03-26 [?] RSPM (R 4.4.0)\n P jsonlite      1.8.9   2024-09-20 [?] RSPM (R 4.4.0)\n P knitr         1.48    2024-07-07 [?] RSPM (R 4.4.0)\n P later         1.3.2   2023-12-06 [?] RSPM (R 4.4.0)\n P lifecycle     1.0.4   2023-11-07 [?] RSPM (R 4.4.0)\n P magrittr      2.0.3   2022-03-30 [?] RSPM (R 4.4.0)\n P memoise       2.0.1   2021-11-26 [?] RSPM (R 4.4.0)\n P mime          0.12    2021-09-28 [?] RSPM (R 4.4.0)\n P miniUI        0.1.1.1 2018-05-18 [?] RSPM (R 4.4.0)\n P pkgbuild      1.4.4   2024-03-17 [?] RSPM (R 4.4.0)\n P pkgload       1.4.0   2024-06-28 [?] RSPM (R 4.4.0)\n P profvis       0.3.8   2023-05-02 [?] RSPM (R 4.4.0)\n P promises      1.3.0   2024-04-05 [?] RSPM (R 4.4.0)\n P purrr         1.0.2   2023-08-10 [?] RSPM (R 4.4.0)\n P R6            2.5.1   2021-08-19 [?] RSPM (R 4.4.0)\n P Rcpp          1.0.13  2024-07-17 [?] RSPM (R 4.4.0)\n P remotes       2.5.0   2024-03-17 [?] RSPM (R 4.4.0)\n   renv          1.0.7   2024-04-11 [1] RSPM (R 4.4.1)\n P rlang         1.1.4   2024-06-04 [?] RSPM (R 4.4.0)\n P rmarkdown     2.28    2024-08-17 [?] RSPM (R 4.4.0)\n P rstudioapi    0.16.0  2024-03-24 [?] RSPM (R 4.4.0)\n P sessioninfo   1.2.2   2021-12-06 [?] RSPM (R 4.4.0)\n P shiny         1.9.1   2024-08-01 [?] RSPM (R 4.4.0)\n P stringi       1.8.4   2024-05-06 [?] RSPM (R 4.4.0)\n P stringr       1.5.1   2023-11-14 [?] RSPM (R 4.4.0)\n P urlchecker    1.0.1   2021-11-30 [?] RSPM (R 4.4.0)\n P usethis     * 3.0.0   2024-07-29 [?] RSPM (R 4.4.0)\n P vctrs         0.6.5   2023-12-01 [?] RSPM (R 4.4.0)\n P xfun          0.48    2024-10-03 [?] RSPM (R 4.4.0)\n P xtable        1.8-4   2019-04-21 [?] RSPM (R 4.4.0)\n P yaml          2.3.10  2024-07-26 [?] RSPM (R 4.4.0)\n\n [1] C:/Users/benia/Desktop/cran-cookbook/cran-cookbook/renv/library/windows/R-4.4/x86_64-w64-mingw32\n [2] C:/Users/benia/AppData/Local/R/cache/R/renv/sandbox/windows/R-4.4/x86_64-w64-mingw32/e0da0d43\n\n P ── Loaded and on-disk path mismatch.\n\n──────────────────────────────────────────────────────────────────────────────\n```\n\n\n:::\n:::\n",
+    "markdown": "---\ntitle: \"Preface\"\nsubtitle: \"\"\nformat: \n  html:\n    css: style.css\n---\n\n\n\n\n\n\n\n\n\n# Motivation\n\n<!-- add this --> \n\n# Introduction\n\nThe CRAN Cookbook has been developed as part of a special project grant from the R Consortium in 2024. The proposal is titled: **Improving the Skills of R Package Maintainers**. The goals of the project are:\n\n1. Educate a diverse cohort of young R developers to acquire the technical knowledge and skills required to participate in the continuous integration of R packages into the R ecosystem.\n2. Develop a new documentation solution with a Quarto website that is user-friendly for new R package maintainers on CRAN.\n3. Identify common CRAN submission issues and create a framework of \"problems\" and \"solutions\" that are easy to implement and discover.\n\n<!-- add more -->\n\n# Prerequisite\n\n- **Beginner to intermediate knowledge of R Programming**: This guide is designed to assist both first-time R package maintainers and those with experience who prefer to navigate a curated selection of the most common issues encountered when submitting to CRAN, as identified by CRAN Maintainers. It provides a 'best practices' approach to resolving R package issues to facilitate a successful re-submission to CRAN.\n\n\n- While not required, it's useful to have experience in debugging code. Submitting your R package to CRAN is a multi-step process that may involve communicating with multiple CRAN volunteers and updating your code, tests, examples, documentation, and other supplementary files to meet acceptance criteria. Developing strong debugging skills can be particularly valuable during this process, as it can help you effectively apply the examples in this cookbook to create custom solutions for updating your R package.\n\n\n# Acknowledgement\n\n- Thank you to the [R Consortium](https://www.r-consortium.org/) for funding and sponsoring this project!\n\n![](https://raw.githubusercontent.com/RConsortium/artwork/main/r_consortium/R_Consortium-logo-horizontal-color.svg){fig-align=\"left\"}\n\n## Contributors\n\n_Thank you to all contributors!_ \n\nIf you are looking to make a contribution to the CRAN Cookbook please see our [contributors guide](https://github.com/r-devel/cran-cookbook/wiki/Contributors-Guide). \n\n- Lluís Revilla ([@llrs](https://github.com/llrs))\n\n- Ivan Krylov ([@aitap](https://github.com/aitap))\n\n# Colophon\n\nThis cookbook is a Quarto website. To learn more about Quarto websites visit <https://quarto.org/docs/websites>. The cookbook is hosted on GitHub pages as part of the [Community R development resources](https://github.com/r-devel). The website is currently deployed with [local commands](https://github.com/r-devel/cran-cookbook/wiki/GitHub-Pages-Deployment).\n\n### Session info \n\n\n\n\n\n\n\n\n\n::: {.cell}\n\n```{.r .cell-code}\nif (!requireNamespace(\"devtools\", quietly = TRUE)) {\n    install.packages(\"devtools\")\n}\nlibrary(devtools)\n```\n\n::: {.cell-output .cell-output-stderr}\n\n```\nLoading required package: usethis\n```\n\n\n:::\n\n```{.r .cell-code}\ndevtools::session_info()\n```\n\n::: {.cell-output .cell-output-stdout}\n\n```\n─ Session info ───────────────────────────────────────────────────────────────\n setting  value\n version  R version 4.4.0 (2024-04-24)\n os       macOS Ventura 13.7.1\n system   x86_64, darwin20\n ui       X11\n language (EN)\n collate  en_US.UTF-8\n ctype    en_US.UTF-8\n tz       America/New_York\n date     2024-11-14\n pandoc   NA (via rmarkdown)\n\n─ Packages ───────────────────────────────────────────────────────────────────\n ! package     * version date (UTC) lib source\n P cachem        1.1.0   2024-05-16 [?] RSPM\n P cli           3.6.3   2024-06-21 [?] RSPM\n P devtools    * 2.4.5   2022-10-11 [?] RSPM\n P digest        0.6.37  2024-08-19 [?] CRAN (R 4.4.1)\n P ellipsis      0.3.2   2021-04-29 [?] RSPM\n P evaluate      1.0.0   2024-09-17 [?] CRAN (R 4.4.1)\n P fastmap       1.2.0   2024-05-15 [?] RSPM\n P fs            1.6.4   2024-04-25 [?] RSPM\n P glue          1.8.0   2024-09-30 [?] CRAN (R 4.4.1)\n P htmltools     0.5.8.1 2024-04-04 [?] RSPM\n P htmlwidgets   1.6.4   2023-12-06 [?] RSPM\n P httpuv        1.6.15  2024-03-26 [?] RSPM\n P jsonlite      1.8.9   2024-09-20 [?] CRAN (R 4.4.1)\n P knitr         1.48    2024-07-07 [?] RSPM\n P later         1.3.2   2023-12-06 [?] RSPM\n P lifecycle     1.0.4   2023-11-07 [?] RSPM\n P magrittr      2.0.3   2022-03-30 [?] RSPM\n P memoise       2.0.1   2021-11-26 [?] RSPM\n P mime          0.12    2021-09-28 [?] RSPM\n P miniUI        0.1.1.1 2018-05-18 [?] RSPM\n P pkgbuild      1.4.4   2024-03-17 [?] RSPM\n P pkgload       1.4.0   2024-06-28 [?] RSPM\n P profvis       0.3.8   2023-05-02 [?] RSPM\n P promises      1.3.0   2024-04-05 [?] RSPM\n P purrr         1.0.2   2023-08-10 [?] RSPM\n P R6            2.5.1   2021-08-19 [?] RSPM\n P Rcpp          1.0.13  2024-07-17 [?] RSPM\n P remotes       2.5.0   2024-03-17 [?] RSPM\n   renv          1.0.7   2024-04-11 [1] CRAN (R 4.4.0)\n P rlang         1.1.4   2024-06-04 [?] RSPM\n P rmarkdown     2.28    2024-08-17 [?] CRAN (R 4.4.1)\n P sessioninfo   1.2.2   2021-12-06 [?] RSPM\n P shiny         1.9.1   2024-08-01 [?] RSPM\n P stringi       1.8.4   2024-05-06 [?] RSPM\n P stringr       1.5.1   2023-11-14 [?] RSPM\n P urlchecker    1.0.1   2021-11-30 [?] RSPM\n P usethis     * 3.0.0   2024-07-29 [?] RSPM\n P vctrs         0.6.5   2023-12-01 [?] RSPM\n P xfun          0.48    2024-10-03 [?] CRAN (R 4.4.1)\n P xtable        1.8-4   2019-04-21 [?] RSPM\n P yaml          2.3.10  2024-07-26 [?] CRAN (R 4.4.0)\n\n [1] /Users/jasminedaly/Desktop/R-directory/cran-cookbook/renv/library/macos/R-4.4/x86_64-apple-darwin20\n [2] /Users/jasminedaly/Library/Caches/org.R-project.R/R/renv/sandbox/macos/R-4.4/x86_64-apple-darwin20/2edc1867\n\n P ── Loaded and on-disk path mismatch.\n\n──────────────────────────────────────────────────────────────────────────────\n```\n\n\n:::\n:::\n",
     "supporting": [
       "preface_files"
     ],

diff --git a/_quarto.yml b/_quarto.yml
@@ -1,18 +1,29 @@
 project:
   type: website
 
+execute:
+  freeze: auto
+
 website:
-  title: CRAN Cookbook
+  title: The CRAN Cookbook
   site-url: https://contributor.r-project.org/cran-cookbook
+  repo-url: https://github.com/r-devel/cran-cookbook
   favicon: favicon.png
+  reader-mode: true
+  page-navigation: true
+  back-to-top-navigation: true
+
   page-footer:
-    center: "<b>This cookbook is currently in development - Please use with caution!</b>"
-    background: info
+    center: "The CRAN Cookbook (2024)"
+
   sidebar:
+    title: The CRAN Cookbook
+    logo: "CRAN Cookbook Hex Sticker.png"
     style: "docked"
     background: light
     search: true
     pinned: true
+    align: center
     contents:
       - index.qmd
       - preface.qmd
@@ -21,27 +32,25 @@ website:
       - code_issues.qmd
       - description_issues.qmd
       - resources.qmd
-
-
     tools:
-      - icon: github
-        menu:
-          - text: Source Code
-            href:  https://github.com/r-devel/cran-cookbook
-          - text: Report a Bug
-            href:  https://github.com/r-devel/cran-cookbook/issues
-          - text: Provide Feedback
-            href:  https://github.com/r-devel/cran-cookbook/discussions
-
+      - icon: bug-fill
+        text: Report a Bug
+        href:  https://github.com/r-devel/cran-cookbook/issues
+        aria-label: Bug
+      - icon: file-plus-fill
+        text: Contribute a Community Recipe
+        href:  https://github.com/r-devel/cran-cookbook/discussions/categories/community-contributions
+        aria-label: Contribute
 
 format:
   html:
-    theme: cosmo
+    theme:
+      light: cosmo
+      dark: [cosmo, theme-dark.scss]
     css: style.css
     toc: true
+    include-in-header: plausible.html
 
-execute:
-  freeze: auto
 
 
 
diff --git a/index.qmd b/index.qmd
@@ -1,12 +1,11 @@
 ---
 title: "Welcome!"
-subtitle: "A complementary self-service guide to discover solutions to common CRAN submission issues"
+subtitle: "The CRAN Cookbook is a complementary self-service guide to discover solutions to common CRAN submission issues."
 author: "Jasmine Daly and Beni Altmann"
 ---
 
 
-
-<img align="right" width="300" height="300" src="CRAN Cookbook Hex Sticker.png">
+<!--<img align="right" width="300" height="300" src="CRAN Cookbook Hex Sticker.png"> -->
 
 
 Welcome to the **CRAN Cookbook**, your go-to guide for solving common (and often recurring) issues spotted by CRAN volunteers during package submissions and re-submissions. Here, you’ll find practical "recipes" organized by different parts of the package structure (e.g., issues with the DESCRIPTION file can be found in the [Description chapter](https://contributor.r-project.org/cran-cookbook/description_issues.html)). The CRAN Cookbook is curated by Jasmine Daly and Beni Altmann, with guidance from a steering committee of experts: Heather Turner, Bettina Grün, and Gwynn Gebeyehu. We encourage [contributions](https://github.com/r-devel/cran-cookbook/discussions/categories/community-contributions) from the community!
@@ -30,4 +29,4 @@ Welcome to the **CRAN Cookbook**, your go-to guide for solving common (and often
 :::
 
 
-<!-- add a citation here -->
+<!-- add a citation here -->
diff --git a/plausible.html b/plausible.html
@@ -0,0 +1,3 @@
+<!-- Snippet for Plausible analytics: https://plausible.io/contributor.r-project.org%2Fcran-cookbook -->
+<script defer data-domain="contributor.r-project.org/cran-cookbook" src="https://plausible.io/js/script.hash.outbound-links.js"></script>
+<script>window.plausible = window.plausible || function() { (window.plausible.q = window.plausible.q || []).push(arguments) }</script>
diff --git a/preface.qmd b/preface.qmd
@@ -36,7 +36,10 @@ The CRAN Cookbook has been developed as part of a special project grant from the
 
 ## Contributors
 
-_Thanks to all contributors!_
+_Thank you to all contributors!_ 
+
+
+If you are looking to make a contribution to the CRAN Cookbook please see our [contributors guide](https://github.com/r-devel/cran-cookbook/wiki/Contributors-Guide). 
 
 - Lluís Revilla ([@llrs](https://github.com/llrs))
 

diff --git a/theme-dark.scss b/theme-dark.scss
@@ -0,0 +1,12 @@
+/*-- scss:defaults --*/
+$body-bg: #181818;
+$body-color: #d0d0d0;
+$link-color: #75AADB;
+$sidebar-bg: #303030;
+$code-background-alpha: -.8;
+$popover-bg: #242424;
+$input-bg: #242424;
+$code-block-bg: #303030;
+$code-bg: #303030;
+$code-color: #b84bb8;
+