Skip to content

update docs to require pkg websites at submission #1004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mpadge wants to merge 3 commits into
base: main
Choose a base branch
from
Open

update docs to require pkg websites at submission #1004

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ddedc4d
update docs to require pkg websites at submission
mpadge May 21, 2026
0f0aec9
Merge branch 'main' into website
maelle May 21, 2026
1646db7
add news item
maelle May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions booknews.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Dev version

- 2026-05-21, update docs to require pkg websites at submission (#1004).
- 2026-04-10, two fixes to roxygen2 tags mentions (#1000, #1001, `@Pakillo`). Now 4 digits for PRs and issues!

## 1.0.0
Expand Down
5 changes: 3 additions & 2 deletions pkg_building.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@ The badge will first indicated "under review" and then "peer-reviewed" once your
- 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).
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).

Expand Down Expand Up @@ -305,7 +305,8 @@ Furthermore, links would not be clickable from local docs.

## Documentation website {#website}

We recommend creating a documentation website for your package using [`pkgdown`](https://github.com/r-lib/pkgdown).
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.
Expand Down
3 changes: 2 additions & 1 deletion pkg_building.es.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,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).

Expand Down Expand Up @@ -305,6 +305,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/).

Expand Down
3 changes: 2 additions & 1 deletion pkg_building.pt.Rmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down Expand Up @@ -270,6 +270,7 @@ Outras pessoas já usaram a opção para escapar de alguns URLs (alterar `<https

## Site de documentação {#website}

Todos os pacotes enviados para revisão de software devem ter um site de documentação claramente indicado no repositório de código-fonte.
Recomendamos a criação de um site de documentação para seu pacote usando o pacote [`pkgdown`](https://github.com/r-lib/pkgdown). O livro *R packages* (em inglês) apresenta um [capítulo sobre pkgdown](https://r-pkgs.org/website.html) e também o `pkgdown` tem [seu próprio site de documentação](https://pkgdown.r-lib.org/).

Há alguns elementos que gostaríamos de destacar aqui.
Expand Down
Loading