Explore converting bookdown to Quarto / BiocBook
還沒有人認領這個 Issue。
評估
- 難度
- 5/5
- 預估耗時
- 一週以上
- 新手友好度
- 25/100
- Issue 類型
- 功能
- 描述清晰度
- 需要釐清
- 活躍度
- 活躍
- 技術堆疊
- github-actions
研究方向
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
-
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.
- 主要語言
- HTML
- 星號
- 16
- 分支
- 27
- 平均合併
- 3 小時 51 分鐘
- 30 天內合併 PR
- 4
環境準備
這個專案沒有提供開發容器、Dockerfile 或貢獻指南,環境需要你自己搭建:先看它的 README,通用步驟見我們的新手貢獻指南。
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
Bioconductor/pkgrevdocs 的其他 Issue
-
難度 4/5 3-5 天 新手友好度 48/100
Bioconductor/pkgrevdocs#184 · 1 則留言 ·
-
Add information regarding SystemRequirements and Third-Party applications可能重新可做 @jwokaty 於 133 天前認領,目前沒有進行中的 PR。 未關閉
Bioconductor/pkgrevdocs#178 · 1 個 reaction · 已指派 1 人 ·
-
難度 2/5 1-3 小時 新手友好度 35/100
Bioconductor/pkgrevdocs#160 · 1 則留言 · 1 個 reaction ·
-
難度 2/5 1-3 小時 新手友好度 52/100
Bioconductor/pkgrevdocs#154 ·
-
Classes未關閉
難度 3/5 1-2 天 新手友好度 35/100
Bioconductor/pkgrevdocs#140 · 1 則留言 · 1 個 reaction ·
查看 Bioconductor/pkgrevdocs 的全部 Issue
相似的 Issue
-
aufwand: klein documentation Einsteiger-Familie freigegeben Haushalts-Admin
難度 2/5 1-3 小時 新手友好度 84/100
維護者通常 1 天內回覆
-
docs(website): add a GitLab CI/CD button next to the GitHub Action button on the homepage可能已有人在做 @shryssssss-maker 今天認領。 未關閉documentation enhancement first-timers-only good first issue
難度 1/5 1-3 小時 新手友好度 88/100
OWASP/cve-lite-cli#1739 · 2 則留言 ·
維護者通常 2 天內回覆
-
難度 1/5 1 小時以內 新手友好度 61/100
scverse/infercnvpy#238 ·
維護者通常 1 天內回覆
-
README documents removed melange/wolfictl images and an sdk welcome prompt that no longer exists可能已有人在做 @officialasishkumar 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 78/100
維護者通常 2 天內回覆
-
難度 1/5 1-3 小時 新手友好度 72/100
daniel-ospina/tortoise#13874 ·
維護者通常 1 天內回覆