Epic: keep hand-written docs from drifting
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Attiva
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
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.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 57
- Fork
- 11
- Merge medio
- 1h 35m
- PR unite (30g)
- 975
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di squid-protocol/gitgalaxy
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
squid-protocol/gitgalaxy#7827 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
scope:frontier
Difficoltà 5/5 Più di una settimana Idoneità per principianti 18/100
squid-protocol/gitgalaxy#7900 ·
I maintainer di solito rispondono entro 1 giorno
-
core-engine scope:infra testing
Difficoltà 4/5 3-5 giorni Idoneità per principianti 54/100
squid-protocol/gitgalaxy#7863 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
squid-protocol/gitgalaxy#7834 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 4/5 3-5 giorni Idoneità per principianti 56/100
squid-protocol/gitgalaxy#7828 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di squid-protocol/gitgalaxy
Issue simili
-
bug good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
graphql-python/graphql-core#304 ·
I maintainer di solito rispondono entro 1 giorno
-
docs size:S
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 1-3 ore Idoneità per principianti 88/100
Gathin23/cleanyourtv#3464 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
I maintainer di solito rispondono entro 1 giorno