From ddedc4d195d02686fe922afc44530a0428ac46b5 Mon Sep 17 00:00:00 2001 From: mpadge Date: Thu, 21 May 2026 10:37:07 +0200 Subject: [PATCH] update docs to require pkg websites at submission --- pkg_building.Rmd | 6 ++++-- pkg_building.es.Rmd | 3 ++- pkg_building.pt.Rmd | 3 ++- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/pkg_building.Rmd b/pkg_building.Rmd index f835ca416..06f99896f 100644 --- a/pkg_building.Rmd +++ b/pkg_building.Rmd @@ -192,7 +192,7 @@ where issue\_id is the number of the issue in the software-review repository. Fo - Consider using `usethis::use_readme_rmd()` to get a template for a `README.Rmd` file and to automatically set up a pre-commit hook to ensure that `README.md` is always newer than `README.Rmd`. -- Extensive examples should be kept for a vignette. If you want to make the vignettes more accessible before installing the package, we suggest [creating a website for your package](#website). +- Extensive examples should be kept for a vignette. If you want to make the vignettes more accessible before installing the package, we suggest [creating a website for your package](#website). All packages submitted for software review must have a website. - Add a [code of conduct and contribution guidelines](#friendlyfiles). @@ -271,7 +271,9 @@ Others have used the option to escape some URLs (change ` ## Documentation website {#website} -We recommend creating a documentation website for your package using [`pkgdown`](https://github.com/r-lib/pkgdown). The R packages book features a [chapter on pkgdown](https://r-pkgs.org/website.html), and of course `pkgdown` has [its own documentation website](https://pkgdown.r-lib.org/). +All packages submitted for software review must have a documentation website clearly linked in the source repository. +We recommend using [`pkgdown`](https://github.com/r-lib/pkgdown) to create your website. +The R packages book features a [chapter on pkgdown](https://r-pkgs.org/website.html), and of course `pkgdown` has [its own documentation website](https://pkgdown.r-lib.org/). There are a few elements we'd like to underline here. diff --git a/pkg_building.es.Rmd b/pkg_building.es.Rmd index d73d6b598..f6ce1bbd3 100644 --- a/pkg_building.es.Rmd +++ b/pkg_building.es.Rmd @@ -201,7 +201,7 @@ La etiqueta indicará primero "en revisión" y luego "revisado" una vez que tu p - Considera utilizar `usethis::use_readme_rmd()` para generar una plantilla para el archivo `README.Rmd` y para configurar automáticamente un chequeo que garantice que `README.md` sea siempre más reciente que `README.Rmd` antes de hacer un commit. - Los ejemplos largos deben incluirse sólo en las viñetas. - Si quieres que las viñetas sean más accesibles antes de instalar el paquete, te sugerimos [crear un sitio web para tu paquete](#website). + Si quieres que las viñetas sean más accesibles antes de instalar el paquete, te sugerimos [crear un sitio web para tu paquete](#website). Todos los paquetes presentados para su revisión deben contar con un sitio web. - Añade un [código de conducta y una guía de contribución](#friendlyfiles). @@ -297,6 +297,7 @@ Además, no se podrá hacer click en los enlaces desde la documentación local. ## Sitio web de documentación {#website} +Todos los paquetes enviados para su revisión de software deben incluir un enlace claro a la página web de documentación en el repositorio de código fuente. Te recomendamos que crees un sitio web con la documentación de tu paquete utilizando [`pkgdown`](https://github.com/r-lib/pkgdown). Hay un [capítulo sobre pkgdown (en inglés)](https://r-pkgs.org/website.html) en libro "R packages", y, cómo no es de extrañar, el paquete `pkgdown` tiene [su propio sitio web de documentación](https://pkgdown.r-lib.org/). diff --git a/pkg_building.pt.Rmd b/pkg_building.pt.Rmd index 62a00ec78..4d5756a03 100644 --- a/pkg_building.pt.Rmd +++ b/pkg_building.pt.Rmd @@ -191,7 +191,7 @@ onde issue\_id é o número da *Issue* no repositório `software-review`. Por ex - Considere o uso da função `usethis::use_readme_rmd()` para obter um modelo para o arquivo `README.Rmd` e para configurar automaticamente uma verificação para garantir que o arquivo `README.md` seja sempre mais recente que o `README.Rmd` antes de fazer um commit. -- Exemplos extensos devem ser mantidos em uma vinheta. Se você quiser tornar as vinhetas mais acessíveis antes de instalar o pacote, sugerimos [criar um site para seu pacote](#website). +- Exemplos extensos devem ser mantidos em uma vinheta. Se você quiser tornar as vinhetas mais acessíveis antes de instalar o pacote, sugerimos [criar um site para seu pacote](#website). Todos os pacotes enviados para revisão de software devem ter um site. - Adicionar um [código de conduta e as diretrizes de contribuição](#friendlyfiles). @@ -270,6 +270,7 @@ Outras pessoas já usaram a opção para escapar de alguns URLs (alterar `