adobe / adobe/spectrum-design-data

Hand-convert ~5 defined terms in token-format.md to native Bikeshed autolinks

Open Beginner friendly
#1,011 0 comments 0 reactions 0 assignees View on GitHub
spec-tooling
Dominant language
Rust
Stars
153
Forks
35
Avg merge
7h 54m
Merged PRs (30d)
111

Description

Part of #1006.

As a representative authoring-cost demo, convert ~5 bolded defined terms in `token-format.md` — e.g. **token**, **name object**, **field catalog**, **resolved value**, **alias** — to `term` definitions at their canonical definition sites and `[=term=]` use-sites elsewhere.

This produces the concrete data point for decision criterion #3 (authoring tax): how much extra markup vs. plain bold, and whether the autolinking payoff is worth it.

Contributor guide

Open the contributing guide

Research direction

Start in token-format.md by locating the canonical definitions and other uses of the five example terms: token, name object, field catalog, resolved value, and alias. Convert those occurrences to the requested Bikeshed definition and autolink forms, then verify that all five terms are covered and the resulting markup can support the authoring-cost comparison.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
85/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.