Explore converting bookdown to Quarto / BiocBook

未關閉
#189 8 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

評估

難度
5/5
預估耗時
一週以上
新手友好度
25/100
Issue 類型
功能
描述清晰度
需要釐清
活躍度
活躍
技術堆疊
github-actions
領域
documentation

研究方向

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.

由索引模型根據 Issue 內容生成。

描述

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.

主要語言
HTML
星號
16
分支
27
平均合併
3 小時 51 分鐘
30 天內合併 PR
4

環境準備

這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

Bioconductor/pkgrevdocs 的其他 Issue

查看 Bioconductor/pkgrevdocs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。