Explore converting bookdown to Quarto / BiocBook

Đang mở
#189 8 bình luận 0 reaction 0 người được giao Xem trên GitHub

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
  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.

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

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Bioconductor/pkgrevdocs

Tất cả issue của Bioconductor/pkgrevdocs

Issue tương tự

Thêm issue về Documentation

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.