search

r-devel / cran-cookbook

Problem and solution documentation for common CRAN issues
http://contributor.r-project.org/cran-cookbook/
42 stars 1 forks source link

Rename cookbook sections #11

Closed jasdumas closed 2 months ago

jasdumas commented 2 months ago

Task(s)

  1. Rename/replace the current .qmd files to these:

    • Manuals & Documentation issues --> docs_issues.qmd
    • Code issues --> code_issues.qmd
    • Description file issues. -> description_issues.qmd

  2. Add a general_issues.qmd section and file

Discussed in https://github.com/r-devel/cran-cookbook/discussions/10

Originally posted by **jasdumas** June 24, 2024 ## Background As we get started on these first few issues of the cookbook, I'm a little stumped on how to organize our content. The first skeleton draft had `.qmd` files for **common**, **occasional** and **infrequent** issues to correspond with the sidebar section labels. The current set of identified issues that @Baltmann01 put together has a different grouping of: - Manuals & Documentation issues - Code issues - Description file issues ## Discussion question 1. Should we first label each of the [issues](https://github.com/orgs/r-devel/projects/3/views/1) by frequency of occurrence to determine which section they might fall into? 1. Should we add just a general issues/best practice section? (I think we might have discussed this in our last team meeting 🤔 )