State in the canon that an entity's ID never changes
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- bash
- Domain
- documentation
Research direction
Start in docs/reference/glossary.md at the § ID uniqueness section and read how it describes IDs, then check the skill workflows named in the issue ("Rename a Feature", "Split or merge a Feature") for the wording to match. Add the never-changes, never-reused rule beside that section, then run bash agentic/scripts/sync-canon-copies.sh all to regenerate the canon copies. Done when the rule appears in the glossary, the regenerated copies carry it, and the AGENTS.md § Check passes.
Written by the indexing model from the issue text.
Description
Description of Technical Debt
Owner decision: an entity's ID (US-, FEAT-, FUNC-, AC:) never changes, not on a rename and not after the entity
is retired, and it is never reused. A rename changes the name only; a split or a merge creates new entities with new
IDs and retires the old one with superseded_by. The agentic layer follows it already: living-doc-update's "Rename a
Feature" changes the name only, and a "Split or merge a Feature" workflow exists. Two tests guard it,
test_entity_ids_never_change and test_retired_id_is_never_reused. docs/reference/glossary.md § ID uniqueness
only implies it ("an ID denotes the same entity everywhere it appears").
Impact of Technical Debt
- The rule lives only in the skills; an author or a tool reading the canon cannot find it.
- The canon copies the skills read are generated from the glossary, so the skills state a rule their own canon lacks.
Category
Documentation
Priority
Medium - Should be addressed soon
Proposed Solution
Add the rule beside § ID uniqueness in docs/reference/glossary.md, regenerate the canon copies (bash agentic/scripts/sync-canon-copies.sh all), and run AGENTS.md § Check.
Effort Estimate
2 hours
Dependencies / Related
No response
Additional Context
Measured 2026-11-12 at living-doc 2df73dc. Re-check:
grep -n -i "never changes" docs/reference/glossary.md is empty while this is open.
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 6h 14m
- Merged PRs (30d)
- 27
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
-
type:tech-debt
Difficulty 1/5 Under an hour Newbie friendliness 78/100
AbsaOSS/living-doc#133 ·
Maintainers usually reply within 1 day
-
type:tech-debt
Difficulty 1/5 1-3 hours Newbie friendliness 85/100
AbsaOSS/living-doc#130 ·
Maintainers usually reply within 1 day
-
type:tech-debt
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
AbsaOSS/living-doc#119 ·
Maintainers usually reply within 1 day
-
type:tech-debt
Difficulty 5/5 Over a week Newbie friendliness 5/100
AbsaOSS/living-doc#136 ·
Maintainers usually reply within 1 day
-
type:tech-debt
Difficulty 4/5 1-2 days Newbie friendliness 18/100
AbsaOSS/living-doc#135 ·
Maintainers usually reply within 1 day
All issues in AbsaOSS/living-doc
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
deepchem/deepchem#5289 · 1 comment ·
Maintainers usually reply within 2 days
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 60/100
UKGovernmentBEIS/inspect_evals#2892 · 1 comment ·
Maintainers usually reply within 1 day
-
Versioning docs: say that no output from the 0.46 warning check means nothing is affectedPossibly taken @grelinfo claimed this today. Opendocumentation priority:low size:S
Difficulty 1/5 Under an hour Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 88/100
alphacrack/readme2demo#293 ·