Epic: keep hand-written docs from drifting

オープン
#7,624 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
python
領域
documentation

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Python
スター
57
フォーク
11
平均マージ
1時間 35分
マージ済み PR(30日)
975

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

squid-protocol/gitgalaxy のほかの issue

squid-protocol/gitgalaxy の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。