Explore converting bookdown to Quarto / BiocBook
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
- Type d'issue
- Fonctionnalité
- Clarté
- À clarifier
- Activité
- Active
- Stack technique
- github-actions
- Domaine
- documentation
Piste de recherche
Read the current bookdown configuration in _bookdown.yml and _output.yml, then compare the standalone Quarto option with the BiocBook::from_bookdown() package migration described here. First determine which approach maintainers want and check the existing GitHub Actions workflow and deployment steps. Done means a prototype direction is agreed; this issue does not yet define a specific migration or acceptance criteria.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Background
The Bioconductor Contributions guidelines book is currently built using bookdown (bookdown::bs4_book).
Recently, there has been discussion around modernizing documentation and making it more accessible to both developers and AI tooling (such as generating an llms.txt index and clean .llms.md versions of chapters for LLM/coding assistants). While bookdown lacks native support for such features, modern Quarto provides native llms-txt: true support (Quarto >= 1.6), along with improved cross-referencing, multi-format rendering, and active toolchain development.
Additionally, the BiocBook package now offers a migration helper, BiocBook::from_bookdown(), designed to facilitate moving existing Bioconductor bookdown repositories over to Quarto.
Options to Consider
-
Standalone Quarto Book:
- Convert chapter
.Rmdfiles to.qmdin place and replace_bookdown.yml/_output.ymlwith a single_quarto.yml. - Update the GitHub Actions workflow to render via
quarto renderand deploy to GitHub Pages as it does today. - Lowest friction; keeps the repository structure familiar without requiring full package layout refactoring.
- Convert chapter
-
Official
BiocBookPackage Structure:- Use
BiocBook::from_bookdown()to transition the project into a standard BiocBook package (inst/pages/, containerized Docker build, versioned with Bioconductor releases). - Aligns with the standard used by other Bioconductor online books (e.g., OSCA).
- Use
Questions for Maintainers
- Is there interest in migrating the contributions guide from
bookdownto Quarto? - If so, would the preferred direction be a standalone Quarto book or adopting the full
BiocBookpackage structure? - Any potential caveats or workflow dependencies we should keep in mind before opening a prototype PR?
Note: This issue was drafted with assistance from Gemini 3.8 Flash.
- Langage dominant
- HTML
- Étoiles
- 16
- Forks
- 27
- Merge moyen
- 3 h 51 min
- PR mergées (30 j)
- 4
Préparer son environnement
Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de Bioconductor/pkgrevdocs
-
Handling system dependenciesOuverte
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
Bioconductor/pkgrevdocs#184 · 1 commentaire ·
-
Add information regarding SystemRequirements and Third-Party applicationsPeut-être à nouveau libre @jwokaty l’a pris il y a 133 jours, et aucune pull request n’est ouverte. Ouverte
Bioconductor/pkgrevdocs#178 · 1 réaction · 1 personne assignée ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 35/100
Bioconductor/pkgrevdocs#160 · 1 commentaire · 1 réaction ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 52/100
Bioconductor/pkgrevdocs#154 ·
-
ClassesOuverte
Difficulté 3/5 1-2 jours Accessibilité débutants 35/100
Bioconductor/pkgrevdocs#140 · 1 commentaire · 1 réaction ·
Toutes les issues de Bioconductor/pkgrevdocs
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 67/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 75/100
UniprJRC/DSwithMATLAB#243 ·
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
UKGovernmentBEIS/inspect_ai#6666 ·
Les mainteneurs répondent en général sous 1 jour
-
docs tech-debt
Difficulté 2/5 1-3 heures Accessibilité débutants 69/100
-
documentation
Difficulté 2/5 1-3 heures Accessibilité débutants 66/100
astrodbtoolkit/astrodb_utils#280 ·