Stale key names and script paths in the agentic layer

Open
  • Is something wrong?
#126 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Refactor
Clarity
Clearly specified
Activity status
Active
Tech stack
python
Domain
documentation, tooling

Research direction

Start with the grep in the issue's Additional Context, then read the closeout gate in living-doc-pageobject-scan SKILL.md around lines 372-377 and scripts/validate_artifacts.py, which sorts by suggested_test_id. The eval assertion is at evals/evals.json:213. Fix the stale data-cy key names, the wrong next_id.py location in the agent file, and the skills/living-doc-shared/ paths in script docstrings and errors, then widen living-doc-shared/test_skill_doc_commands.py to agent files and *.py docstrings. Done when the grep returns no hits outside tests and the widened guard passes.

Written by the indexing model from the issue text.

Description

type:tech-debt
Description of Technical Debt
  • living-doc-pageobject-scan's closeout gate (SKILL.md:372-377) speaks of data-cy and data_cy /
    suggested_data_cy, while scripts/validate_artifacts.py sorts by suggested_test_id. Answers repeat the old
    names, and two runs claimed the keys "must use camelCase". The eval assertion at evals/evals.json:213 rewards the
    old names.
  • The agent names scripts/next_id.py (agentic/.github/agents/living-doc-bdd-copilot.agent.md:243, :336). The
    script exists only in the three living-doc-create-* skills' scripts/.
  • Script docstrings and error messages name skills/living-doc-shared/, a path that does not exist after an
    install, where the sibling is ../living-doc-shared/. Examples: gherkin-living-doc-sync/scripts/scan_ac_links.py:26,
    :28, :43; the next_id.py wrappers; living-doc-update/scripts/validate_entity.py. The guard
    living-doc-shared/test_skill_doc_commands.py reads only SKILL.md.
Impact of Technical Debt
  • Users are sent to keys and paths that do not exist.
Category

Code Quality / Refactoring

Priority

Low - Nice to have

Proposed Solution

Use test_id / suggested_test_id in the gate and fix the assertion. Name the create skill that owns next_id.py. Widen test_skill_doc_commands.py to agent files and *.py docstrings, then fix what it finds.

Effort Estimate

1 day

Dependencies / Related

No response

Additional Context

Measured 2026-11-12 at living-doc 2df73dc. Re-check:

grep -rn "skills/living-doc-shared" --include="*.py" agentic/.claude/skills/ | grep -v test_

Dominant language
Python
Stars
0
Forks
0
Avg merge
6h 14m
Merged PRs (30d)
27

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AbsaOSS/living-doc

All issues in AbsaOSS/living-doc

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.