Explore converting bookdown to Quarto / BiocBook
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
-
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.
- 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
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de Bioconductor/pkgrevdocs
-
Handling system dependenciesAberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
Bioconductor/pkgrevdocs#184 · 1 comentário ·
-
Add information regarding SystemRequirements and Third-Party applicationsTalvez livre de novo @jwokaty assumiu há 133 dias e não há nenhum pull request aberto. Aberta
Bioconductor/pkgrevdocs#178 · 1 reação · 1 responsável ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 35/100
Bioconductor/pkgrevdocs#160 · 1 comentário · 1 reação ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 52/100
Bioconductor/pkgrevdocs#154 ·
-
ClassesAberta
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 35/100
Bioconductor/pkgrevdocs#140 · 1 comentário · 1 reação ·
Todas as issues de Bioconductor/pkgrevdocs
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 67/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 75/100
UniprJRC/DSwithMATLAB#243 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
UKGovernmentBEIS/inspect_ai#6666 ·
Mantenedores costumam responder em até 1 dia
-
docs tech-debt
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 69/100
-
documentation
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
astrodbtoolkit/astrodb_utils#280 ·