Add `ref` as Alias for `xref`

main View source

Criteria completion

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

main current done

claude/file-naming-convention-LJdwR done changeset-release/main done

Apr 21, 01:46 PMe900a90
Created (done)by bjornolofandersson
Apr 10, 06:58 PMf262d7b
Content editedby Claude
Mar 23, 07:16 AMdc97198
- ☑ `{% 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
by Claude
Mar 23, 07:12 AM38e7523
Content editedby Claude
Mar 22, 07:25 PM3fc7634
Created (pending)by Claude
Add work items for remaining SPEC-021 plan runes gaps

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.