Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

docs: versioned docs per release (/vX.Y/, /latest/, /dev/)

Đang mở
  • Có gì không ổn?
#1,272 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
c, shell
Lĩnh vực
build-system, documentation, release

Hướng nghiên cứu

The docs are in the docs/ directory; the release workflow and build system need changes to publish per-version docs. Start by examining the existing documentation build script (likely a shell script or Makefile) and the GitHub Actions workflow for releases. Understand how the current site is deployed. The goal is to create a structure where each release tag's docs are published under /vX.Y/, /latest/ points to the newest release, and main's docs go to /dev/. This involves versioning the docs, adding version markers to pages, and ensuring old versions remain accessible.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

area:docs help wanted kind:decision

Problem. The docs site is built from main only. A user on the latest release (v0.43.0) reads docs for whatever is on main, which can describe features, flags or semantics their binary does not have.

What mature languages do. docs.python.org/3.12/, docs.rs//, and pkg.go.dev's version tab all serve each release's docs, with a stable "latest".

Bar.

  1. Each release tag's docs/ is published under /v<major.minor>/, and /latest/ points at the newest release. main's docs are published under /dev/ (or equivalent), clearly labelled unreleased.
  2. Every page carries a visible version marker, with a link to the same page in other versions where it exists.
  3. The release-cut workflow publishes the new version's docs, and the playground is built from the same tag.
  4. Old versions keep working after a new release (a link check against at least the previous version).

Ranked #5 of the docs follow-ups (2026-09-22 comparison with other languages). Most work; matters most once there are outside users.

Ngôn ngữ chính
C
Star
3
Fork
7
Merge trung bình
3 giờ 56 phút
Pull request đã merge (30 ngày)
102

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 InauguralSystems/EigenScript

Tất cả issue của InauguralSystems/EigenScript

Issue tương tự

Thêm issue về C

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.