Merge pull request #73 from r-devel/chapter-intros

Chapter intros

Author: jasdumas

code_issues.qmd

@@ -1,5 +1,6 @@
 ---
 title: "Code Issues"
+subtitle: "The Code Issues chapter provides recipes for addressing common challenges in writing functions, managing file and directory operations, and handling installation and compute resources."
 format: 
   html:
     css: style.css

description_issues.qmd

@@ -1,5 +1,6 @@
 ---
 title: "DESCRIPTION File Issues"
+subtitle: "The DESCRIPTION Files Issues chapter features recipes on content formatting, license structuring, and how to include additional background context & links."
 format: 
   html:
     css: style.css

docs_issues.qmd

@@ -1,5 +1,6 @@
 ---
 title: "Manuals & Documentation Issues"
+subtitle: "The Manuals & Documentation Issues chapter provides recipes on help documentation files, using **roxygen2**, and creating examples, vignettes, and tests."
 format: 
   html:
     css: style.css

general_issues.qmd

@@ -1,12 +1,12 @@
 ---
 title: "General Issues"
-subtitle: "General issues and helpful notes around CRAN submission best practices."
+subtitle: "The General Issues chapter offers practical tips on CRAN submission best practices, essential file and example structuring, and key meta package requirements."
 format: 
   html:
     css: style.css
 ---
 
-# Structure of CRAN-Submissions
+<!-- # Structure of CRAN-Submissions -->
 
 <!-- I would add a section about the path of packages when they are submitted to CRAN.
 Where do they end up and who will look at them etc... -->

preface.qmd

@@ -8,7 +8,9 @@ format:
 
 # Motivation
 
-<!-- add this --> 
+The CRAN Cookbook was created to address common issues in R package submissions and re-submissions to CRAN, which often cause delays or package archiving. While solutions are available in the **Writing R Extensions** manual and **CRAN Repository Policy**, they can be difficult for maintainers to interpret and apply quickly. By offering user-friendly guidance, the cookbook aims to empower maintainers to resolve problems efficiently, streamline the submission process, and improve the feedback loop with the CRAN Team. Ultimately, this resource seeks to build confidence and the knowledge base of package maintainers.
+
+The authors delivered a talk on *The CRAN Cookbook* at the virtual [LatinR Conference](https://latinr.org/en/) on November 20, 2024. The recording of the talk is available on [YouTube](https://www.youtube.com/watch?v=3QR1ez6CVTo).
 
 # Introduction
 
@@ -18,8 +20,6 @@ The CRAN Cookbook has been developed as part of a special project grant from the
 2. Develop a new documentation solution with a Quarto website that is user-friendly for new R package maintainers on CRAN.
 3. Identify common CRAN submission issues and create a framework of "problems" and "solutions" that are easy to implement and discover.
 
-<!-- add more -->
-
 # Prerequisite
 
 - **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.

resources.qmd

@@ -1,6 +1,6 @@
 ---
 title: "Additional Resources"
-subtitle: ""
+subtitle: "The CRAN Cookbook is designed to complement other key resources listed below for developing R packages intended for distribution on CRAN."
 format: 
   html:
     css: style.css