Explore converting bookdown to Quarto / BiocBook

Aberta
#189 8 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Avaliação

Dificuldade
5/5
Tempo estimado
Mais de uma semana
Facilidade para iniciantes
25/100
Tipo de issue
Funcionalidade
Clareza
Precisa de esclarecimento
Status de atividade
Ativa
Stack de tecnologia
github-actions
Domínio
documentation

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Descrição

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.

Linguagem predominante
HTML
Estrelas
16
Forks
27
Merge médio
3h 51min
PRs com merge (30d)
4

Preparar o ambiente

Este projeto não oferece contêiner de desenvolvimento, Dockerfile nem guia de contribuição, então a configuração fica por sua conta: comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Mais de Bioconductor/pkgrevdocs

Todas as issues de Bioconductor/pkgrevdocs

Issues semelhantes

Mais issues de Documentation

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.