Epic: keep hand-written docs from drifting

Abierto
#7,624 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
python

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
Python
Estrellas
57
Forks
11
Merge medio
1 h 35 min
PR fusionados (30 d)
975

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de squid-protocol/gitgalaxy

Todos los issues de squid-protocol/gitgalaxy

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.