Skip to content

docs(register): document file structure confusion#8

Open
ronaldtse wants to merge 1 commit intov1from
docs-file-structure-confusion-v2
Open

docs(register): document file structure confusion#8
ronaldtse wants to merge 1 commit intov1from
docs-file-structure-confusion-v2

Conversation

@ronaldtse
Copy link
Contributor

This document explains the confusion between legacy single-file definitions and v2 implementation version files.

Problem

When fixing the batch_process default for Inkscape, I edited tools/inkscape/1.0.yaml but the v2 loader uses tools/inkscape/default/1.0.yaml. This caused the fix to not take effect.

Solution

This PR adds documentation explaining:

  • Which files are loaded by which code path
  • Why there are two types of files
  • Recommended solutions to avoid future confusion

Related: #7 (the fix for batch_process)

ronaldtse added a commit that referenced this pull request Feb 20, 2026
Delete all legacy {version}.yaml files from tool directories.
The register now uses ONLY the implementation-based format:

  tools/{tool}/
  ├── index.yaml              # Implementation index
  └── {implementation}/       # Implementation directory
      └── {version}.yaml      # Version definition

This eliminates the confusion documented in PR #8 where developers
were editing the wrong file. There is now ONE format with no
ambiguity about which file is the source of truth.

Deleted: 83 legacy YAML files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant