review ai-updates text after feedback from @yabellini#1013
Conversation
maelle
left a comment
maelle
left a comment
There was a problem hiding this comment.
Thanks a lot! As noted elsewhere, I feel we might first want a blog post with a list of example usage + commentary. Then we can come back to updating the dev guide. What do y'all think?
|
|
||
| - Please provide easy-to-find details or links on any usage of generative AI tools in your documentation, like in [this package](https://apaf-bioinformatics.github.io/HydraR/#robot-use-of-generative-ai). | ||
| - A very general rule-of-thumb is the greater the use of generative AI tools in an rOpenSci submission, the more documentation we will expect, and the more we will expect such tools to have been used _systematically_. | ||
| - Systematic tool usage includes any approach which transparently and progressively details the contribution of generative AI tools to software production. |
Blog post PR is ropensci/roweb3#1310 - we could wait for that before moving ahead here, if you want? but that might take a couple of weeks, so I'd prefer to merge this, and update again in response to that blog post. |
|
From a quick skim, that post is more ambitious than what I was envisioning: what I meant is a blog post full of links to issue comments in software-review, and code source that was mentioned in software-review. Actual examples. Could be a first/second post? |
|
So, in short, a post about what we have observed in software review threads since our first post on AI. What was good, in particular, so not shaming anyone 😁 |
|
What's this PR in relation to the other AI updates PR? |
See my comment at the start of this. It's a PR into that PR, done that way just so @yabellini can see what changes I made in response to her comment there. So @yabellini if this looks good, can you please merge into main |
|
Sorry, I put some comments on the other PR; I missed this one. I will read and work on this one. |
|
The two branches are now conflicting @mpadge |
fixed; thanks |
yabellini
left a comment
yabellini
left a comment
There was a problem hiding this comment.
Review of the Spanish translation.
|
|
||
| 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/). |
There was a problem hiding this comment.
Perhaps we can link to this resource in Spanish? https://intro-programacion.netlify.app/10_documentacion
|
@maelle: I've rewritten this again in response to your comments. @yabellini This means you will unfortunately need to go through the translations once again. Thank you both 🙏 |
3 participants
@yabellini You wisely suggested we needed an example of AI usage disclosure. This is a PR to the
ai-updatesbranch that does that. I've done as a separate PR so you can see what's changed. We really only have one good example to date, and it's of a package still under review. I'll keep an eye on progress, and update link and description if and when things get that far, but hopefully this should help people understand.Good idea - thanks 👍
Checklist for dev guide maintainers, do not delete 😸