No test checks that a page's facts have code-map items
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 48/100
Research direction
Read tests/docs/test_anchors.py and inspect the depth-2 pages and their adjacent CONTEXT.md files to understand the existing code-map checks. The proposal defines facts as code spans naming a symbol, path, or input, but leaves the detection and matching rules to decide. Done means a check can detect when such a fact has no corresponding code-map item.
Written by the indexing model from the issue text.
Description
Description of Technical Debt
Every depth-2 page's anchors live in the ## Code map of the CONTEXT.md beside it. tests/docs/test_anchors.py
checks that each anchor resolves and that every depth-2 page has a code map, not that each fact on the page has an
item; review samples it. The same holds in every repository that copied the page checks.
Impact of Technical Debt
- A fact can lose its code anchor unnoticed.
Category
Testing / Test Coverage
Priority
Low - Nice to have
Proposed Solution
If a review or a gate finds a fact with no code-map item: define what counts as a fact (a code span naming a symbol, path or input) and check each has an item.
Effort Estimate
2 days
Dependencies / Related
No response
Additional Context
Measured 2026-11-12 at living-doc-toolkit fea9aa6 (v0.1.0). Re-check:
grep -n 'def test_' tests/docs/test_anchors.py
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 19
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 AbsaOSS/living-doc-toolkit
-
tech debt
Difficulty 1/5 Under an hour Newbie friendliness 88/100
AbsaOSS/living-doc-toolkit#120 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 Half a day Newbie friendliness 84/100
AbsaOSS/living-doc-toolkit#118 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
AbsaOSS/living-doc-toolkit#116 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
AbsaOSS/living-doc-toolkit#115 ·
Maintainers usually reply within 1 day
-
tech debt
Difficulty 4/5 1-2 days Newbie friendliness 55/100
AbsaOSS/living-doc-toolkit#119 ·
Maintainers usually reply within 1 day
All issues in AbsaOSS/living-doc-toolkit
Similar issues
-
documentation good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
JheysonJhordyHuarauyaRiquelme/sprocguard#18 ·
Maintainers usually reply within 1 day
-
enhancement good first issue help wanted
Difficulty 2/5 1-3 hours Newbie friendliness 80/100
dlq/synthpopcan#59 ·
Maintainers usually reply within 2 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
mdn/translated-content#40220 ·
Maintainers usually reply within 4 days
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
ETSInitiative/PETSIRD#243 ·
Maintainers usually reply within 1 day
-
deferred p2
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
cuadrao-ai/argus#2160 ·
Maintainers usually reply within 1 day