Description
All 38 registered custom ESLint rules in eslint-factory/** build a doc link of the form .../eslint-factory#<rule-name>, but 10 of those rules currently have no matching README section, so the generated link 404s and contributors have no discoverable rationale for the lint warnings they hit. This documentation debt has been flagged as a priority in repo-memory across at least two prior runs (2026-07-08, 2026-07-05) but was never filed as a concrete issue until now.
Suggested Changes
- Identify the 10 rules in
eslint-factory/** that lack a corresponding README section (cross-reference registered rule names against README anchors).
- Add a README section for each undocumented rule following the existing format used by documented rules (rationale, example violation, example fix).
- Verify each rule's doc link (
.../eslint-factory#<rule-name>) resolves correctly after the update.
Files Affected
eslint-factory/README.md (or equivalent README file)eslint-factory/** rule source files (for rule name reference only, no code changes needed)
Success Criteria
- All 38 registered rules have a matching, non-404 README section.
- Each new section follows the existing documentation format/style.
Source
Extracted from ESLint Refiner Daily Report discussion #50198
Priority
Medium - Recurring, previously-flagged documentation debt affecting contributor discoverability.
🔍 Task mining by Discussion Task Miner - Code Quality Improvement Agent · auto · 35.8 AIC · ⌖ 4.24 AIC · ⊞ 10.3K · ◷
Description
All 38 registered custom ESLint rules in
eslint-factory/**build a doc link of the form.../eslint-factory#<rule-name>, but 10 of those rules currently have no matching README section, so the generated link 404s and contributors have no discoverable rationale for the lint warnings they hit. This documentation debt has been flagged as a priority in repo-memory across at least two prior runs (2026-07-08, 2026-07-05) but was never filed as a concrete issue until now.Suggested Changes
eslint-factory/**that lack a corresponding README section (cross-reference registered rule names against README anchors)..../eslint-factory#<rule-name>) resolves correctly after the update.Files Affected
eslint-factory/README.md(or equivalent README file)eslint-factory/**rule source files (for rule name reference only, no code changes needed)Success Criteria
Source
Extracted from ESLint Refiner Daily Report discussion #50198
Priority
Medium - Recurring, previously-flagged documentation debt affecting contributor discoverability.