Epic: keep hand-written docs from drifting
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- python
- Domain
- documentation
Research direction
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.
Written by the indexing model from the issue text.
Description
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.
- Dominant language
- Python
- Stars
- 57
- Forks
- 11
- Avg merge
- 1h 35m
- Merged PRs (30d)
- 975
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from squid-protocol/gitgalaxy
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
squid-protocol/gitgalaxy#7827 · 1 comment ·
Maintainers usually reply within 1 day
-
scope:frontier
Difficulty 5/5 Over a week Newbie friendliness 18/100
squid-protocol/gitgalaxy#7900 ·
Maintainers usually reply within 1 day
-
core-engine scope:infra testing
Difficulty 4/5 3-5 days Newbie friendliness 54/100
squid-protocol/gitgalaxy#7863 · 1 comment ·
Maintainers usually reply within 1 day
-
enhancement
Difficulty 5/5 Over a week Newbie friendliness 35/100
squid-protocol/gitgalaxy#7834 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 4/5 3-5 days Newbie friendliness 56/100
squid-protocol/gitgalaxy#7828 · 1 comment ·
Maintainers usually reply within 1 day
All issues in squid-protocol/gitgalaxy
Similar issues
-
docs size:S
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
strawberry-graphql/strawberry#4794 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
dataforgoodfr/cetolog#21 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
btclib-org/btclib#2932 ·
Maintainers usually reply within 1 day