Explore converting bookdown to Quarto / BiocBook
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Attiva
- Stack tecnologico
- github-actions
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- HTML
- Stelle
- 16
- Fork
- 27
- Merge medio
- 3h 51m
- PR unite (30g)
- 4
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di Bioconductor/pkgrevdocs
-
Handling system dependenciesAperta
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
Bioconductor/pkgrevdocs#184 · 1 commento ·
-
Add information regarding SystemRequirements and Third-Party applicationsForse di nuovo libera @jwokaty l’ha presa 133 giorni fa e non c’è nessuna pull request aperta. Aperta
Bioconductor/pkgrevdocs#178 · 1 reazione · 1 assegnatario ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 35/100
Bioconductor/pkgrevdocs#160 · 1 commento · 1 reazione ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 52/100
Bioconductor/pkgrevdocs#154 ·
-
ClassesAperta
Difficoltà 3/5 1-2 giorni Idoneità per principianti 35/100
Bioconductor/pkgrevdocs#140 · 1 commento · 1 reazione ·
Tutte le issue di Bioconductor/pkgrevdocs
Issue simili
-
AWS Cloud WAN: BGP communities now supported on Direct Connect attachments for routing policyApertacorrection documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
aws/aws-networking-best-practices#212 ·
I maintainer di solito rispondono entro 2 giorni
-
ready-for-agent
Difficoltà 1/5 1-3 ore Idoneità per principianti 79/100
gregwebs/agent-vm-images#216 ·
I maintainer di solito rispondono entro 1 giorno
-
Python 3 test-infra
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
pyrevitlabs/pyRevit#4159 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
I maintainer di solito rispondono entro 1 giorno
-
needs discussion
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
openfga/openfga.dev#1436 · 1 commento ·
I maintainer di solito rispondono entro 2 giorni