Add `ref` as Alias for `xref`

claude/file-naming-convention-LJdwR View source

Criteria completion

No incremental history — criteria tracking started on Apr 21.

Relationships

ID:SPEC-008Status:review

Unbuilt Runes — High-Level Spec

ID:SPEC-021Status:draft

Plan Runes

Version:1.0

ID:WORK-021Status:done

Update Plan Documents to Use Xref Syntax

Priority:high

claude/file-naming-convention-LJdwR current done

main done changeset-release/main done

Apr 21, 01:29 PMbbbb94c
Created (done)by bjornolofandersson
Apr 21, 01:17 PMf2b3512
Content editedby Claude
Add {ID}-{slug}.md filename convention + migrate filenames subcommand

Summary

SPEC-021 uses {% ref "SPEC-008" /%} syntax for cross-references. The codebase has {% xref %}. Add ref as an alias for xref so both syntaxes work. This keeps the plan spec examples valid and provides a shorter, more natural syntax for inline references.

Acceptance Criteria

{% ref "SPEC-008" /%} produces identical output to {% xref "SPEC-008" /%}
ref registered as alias in the xref tag schema (packages/runes/src/tags/xref.ts)
All xref attributes work with the ref alias (label, type)
Test verifying alias produces same output

Approach

Add ref to the xref tag's aliases array in the Markdoc schema definition. No changes to the transform logic needed — Markdoc handles alias resolution automatically.