add-resource

Add Resource

Always use the skill load-plain-reference to retrieve the ***plain syntax rules — but only if you haven't done so yet.

Linked resources are external files referenced from within a .plain spec using markdown link syntax. The file contents are passed to the renderer alongside the spec, providing additional context for code generation.

Workflow

1. Identify or create the resource file. Keep it inside the project — the resources/ directory is the conventional home; it does not have to sit next to the .plain file.
2. Add the markdown link at the appropriate place in the spec.
3. Verify the file path is relative to the .plain file location.
4. Read the file back to confirm correct link syntax and path.

Format

Use standard markdown link syntax inside any spec section:

***definitions***
- :AuthData: is the authentication data structure.
  - Its format is defined in the [auth schema](resources/auth_schema.json).

***implementation reqs***
- When transforming :BackupData:, use the JOLT transform.
  - The transform is defined in [backup_transform.jolt](resources/backup_transform.jolt).

***functional specs***

- An API conforming to the [API specification](resources/api_spec.yaml) is exposed.

Path Rules

• Paths are resolved against the directory that contains the .plain file passed to the renderer, not the directory where the renderer is run.
• This includes links inside imported and required modules — they resolve against that same directory, not against the directory the imported module itself lives in.
• A path that does not resolve there is then looked up in the template-dir directory (if configured), and last in the renderer's built-in template library.
• Relative paths may traverse into parent directories — [resource](../../resources/resource.md) is valid — as long as they resolve to a real text file on disk.
• No external URLs — only local file references.
• No folder paths — the target must be a file, not a directory.
• Only text-based files are supported.