Explore converting bookdown to Quarto / BiocBook
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 5/5
- Thời gian dự kiến
- Hơn một tuần
- Mức phù hợp với người mới
- 25/100
- Loại issue
- Tính năng
- Độ rõ ràng
- Cần làm rõ
- Mức độ hoạt động
- Sôi nổi
- Công nghệ
- github-actions
- Lĩnh vực
- documentation
Hướng nghiên cứu
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.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- HTML
- Star
- 16
- Fork
- 27
- Merge trung bình
- 3 giờ 51 phút
- Pull request đã merge (30 ngày)
- 4
Chuẩn bị môi trường
Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của Bioconductor/pkgrevdocs
-
Handling system dependenciesĐang mở
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
Bioconductor/pkgrevdocs#184 · 1 bình luận ·
-
Add information regarding SystemRequirements and Third-Party applicationsCó thể làm lại được @jwokaty đã nhận 133 ngày trước và không có pull request nào đang mở. Đang mở
Bioconductor/pkgrevdocs#178 · 1 reaction · 1 người được giao ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 35/100
Bioconductor/pkgrevdocs#160 · 1 bình luận · 1 reaction ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 52/100
Bioconductor/pkgrevdocs#154 ·
-
ClassesĐang mở
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
Bioconductor/pkgrevdocs#140 · 1 bình luận · 1 reaction ·
Tất cả issue của Bioconductor/pkgrevdocs
Issue tương tự
-
AWS Cloud WAN: BGP communities now supported on Direct Connect attachments for routing policyĐang mởcorrection documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
aws/aws-networking-best-practices#212 ·
Maintainer thường phản hồi trong vòng 2 ngày
-
ready-for-agent
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 79/100
gregwebs/agent-vm-images#216 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Python 3 test-infra
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
pyrevitlabs/pyRevit#4159 ·
Maintainer thường phản hồi trong vòng 1 ngày
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 65/100
Maintainer thường phản hồi trong vòng 1 ngày
-
needs discussion
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 78/100
openfga/openfga.dev#1436 · 1 bình luận ·
Maintainer thường phản hồi trong vòng 2 ngày