nadavWeisler / nadavWeisler/MedCodeTranslator

[Docs] Fix copilot-instructions and script comments data path drift

Open Beginner friendly
#84 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
0
Forks
0
Avg merge
7m
Merged PRs (30d)
7

Description

Problem summary

.github/copilot-instructions.md tells contributors datasets live in assets/data/, but the app and architecture docs use data/vocabularies/. This causes incorrect guidance for AI agents and new contributors.

Affected area

  • .github/copilot-instructions.md
  • scripts/fetch-data.js (stale header comment)
  • DATA_SOURCES.md, docs/architecture.md

Expected behavior

All contributor and agent docs reference the same canonical vocabulary path.

Actual behavior

Conflicting paths across docs increase the risk of fixes landing in the wrong directory.

Acceptance criteria

  • copilot-instructions.md references the canonical data path.
  • Stale comments in scripts/fetch-data.js are corrected.
  • Cross-doc audit confirms no remaining assets/data/ references for runtime vocabularies (or documents intentional legacy use).

Contributor guide

Open the contributing guide

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.

Research direction

Start by reviewing .github/copilot-instructions.md, scripts/fetch-data.js, DATA_SOURCES.md, and docs/architecture.md, then search the repository for assets/data/ references. Update the contributor and script guidance to use the canonical data/vocabularies/ path, and confirm the audit finds no conflicting runtime-vocabulary references or that any intentional legacy use is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
78/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.