Explore converting bookdown to Quarto / BiocBook

Aperta
#189 8 commenti 0 reazioni 0 assegnatari Vedi su GitHub

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
  1. Standalone Quarto Book:

    • Convert chapter .Rmd files to .qmd in place and replace _bookdown.yml/_output.yml with a single _quarto.yml.
    • Update the GitHub Actions workflow to render via quarto render and deploy to GitHub Pages as it does today.
    • Lowest friction; keeps the repository structure familiar without requiring full package layout refactoring.
  2. Official BiocBook Package 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).
Questions for Maintainers
  1. Is there interest in migrating the contributions guide from bookdown to Quarto?
  2. If so, would the preferred direction be a standalone Quarto book or adopting the full BiocBook package structure?
  3. 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

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di Bioconductor/pkgrevdocs

Tutte le issue di Bioconductor/pkgrevdocs

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.