Explore converting bookdown to Quarto / BiocBook

Ouverte
#189 8 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

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
  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.

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

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de Bioconductor/pkgrevdocs

Toutes les issues de Bioconductor/pkgrevdocs

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.