Instruction file imported from techie2000/iso20022 (
.github/instructions/ilograph-sync.instructions.md). Copyright stays with the author.
Ilograph Diagram Sync
Use this instruction to keep repository Ilograph files accurate as the codebase evolves.
Scope
Track these files:
docs/diagrams/*.ilograph.yaml
Required Updates
- When folders, significant files, or ownership boundaries change, update
workspace-overview.ilograph.yamlin the same PR. - Keep resource names and relation labels aligned with actual paths and
behavior in
src/,scripts/, andtest/. - If a change intentionally does not update diagrams, document why in the PR summary.
Ordering Rules (Deterministic)
Use a stable ordering policy so diagram diffs remain small as files are added.
- Keep top-level
resourceschildren in functional order:docs,src,test,scripts, then tooling/config sections. - Within each node's
children, use alphabetical order unless a strict runtime flow sequence is required. - Keep
perspectives[].relationsgrouped and ordered consistently: Makefile/task relations first, hook/script relations second, CI relations third, and governance/instruction relations last. - Prefer one relation per edge (
from->to) for easier review and clearer diffs when adding new nodes. - When adding a new file/folder, insert it at its sorted position instead of appending to the end.
Quality Gate
Before finalizing markdown or instruction updates related to diagrams:
- Run
make lint-docs-fix - Run
make lint-docs - Resolve any remaining markdown lint issues