Skip to content

Commit 3f14ffb

Browse files
committed
docs: add generated-output README and legacy-guide pointer
1 parent fcab224 commit 3f14ffb

2 files changed

Lines changed: 24 additions & 0 deletions

File tree

documentation/how-to/TOKEN_SYSTEM_GUIDE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
# Token System Guide
22

3+
> **Note:** A new Tokens Studio-based pipeline is being phased in — see
4+
> [`documentation/agent-instructions/TOKENS_STUDIO.md`](../agent-instructions/TOKENS_STUDIO.md).
5+
> This guide covers the **legacy pipeline** (Figma REST sync + Style Dictionary),
6+
> which still owns everything the `@equinor/eds-tokens` package publishes.
7+
38
This guide provides a comprehensive walkthrough of the <abbr title="Equinor Design System">EDS</abbr> token system – from Figma setup through syncing, building, and implementation. It covers the complete token lifecycle and serves as documentation for working with design tokens in the EDS.
49

510
## Table of Contents
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Generated token output — do not edit
2+
3+
Everything in this directory is written by the Tokens Studio release
4+
workflow (`.github/workflows/tokens_studio_release.yaml`) and committed
5+
through its automated pull requests. **Never edit these files by hand**
6+
the next release run regenerates them and silently overwrites manual
7+
changes. Fix token values in Tokens Studio instead.
8+
9+
| Directory | Content | Produced by |
10+
| ---------- | -------------------------------------- | ----------------------------------------------- |
11+
| `<alias>/` | Raw token sets (JSON, with `{alias}`s) | `studio tokens pull` (sources in `.studio.json`) |
12+
| `css/` | CSS custom properties | `studio exports run` (EDS-CSS configuration) |
13+
| `dtcg/` | DTCG interchange JSON | `studio exports run` (EDS-DTCG configuration) |
14+
| `ts/` | TypeScript modules | `pnpm run generate:ts-tokens` (combines `dtcg/` + `css/`) |
15+
16+
None of this is wired into the package `exports` map yet — the published
17+
artifacts still come from the legacy Style Dictionary build in `build/`.
18+
19+
Pipeline documentation: [`documentation/agent-instructions/TOKENS_STUDIO.md`](../../../../documentation/agent-instructions/TOKENS_STUDIO.md).

0 commit comments

Comments
 (0)