Epic: keep hand-written docs from drifting

Đang mở
  • Có gì không ổn?
#7,624 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ó
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
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Read the epic and its linked issues #7625–#7628 to understand the remaining work; #7623 is already merged. The plan covers worker checks, generated or tested counts, a nightly issue filing job, and periodic judgment sweeps. This epic is complete when those four remaining pieces are done; the payload does not identify their implementation files or tests.

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

Mô tả

documentation epic

Hand-written docs drift: the #7617 sweep fixed 113 files. Plan agreed with the owner on 2026-11-03: mechanical checks in CI, issues for the churn, and an occasional judgment sweep, instead of making every worker PR edit docs or running a nightly PR.

  • 1. tests/doc_refs_audit.py, the baseline-gated check (#7623, merged)
  • 2. Workers fix the doc-refs findings they cause, with markdown outside the 5-file cap (#7625)
  • 3. Docs stop copying numbers: counts are generated or pinned by a test (#7626)
  • 4. A nightly drift job files issues, not PRs (#7627)
  • 5. A periodic judgment sweep files issues (#7628)

Why not "every PR updates the docs": send-backs are 24% at 3-4 files and 50% at 5 (re-measured 2026-10-26), and README, CLAUDE.md and ecosystem.md would turn into conflict magnets. Why not a nightly agent PR: the #7617 sweep cost about 1.5M tokens and produced a 113-file PR, and most of what it found was mechanical drift a check catches for free.

Ngôn ngữ chính
Python
Star
57
Fork
11
Merge trung bình
1 giờ 42 phút
Pull request đã merge (30 ngày)
966

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

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 squid-protocol/gitgalaxy

Tất cả issue của squid-protocol/gitgalaxy

Issue tương tự

Thêm issue về Python

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.