Skip to content

docs: add ADR for temporary next subpaths during eds-tokens beta - #5194

Merged
pomfrida merged 1 commit into
mainfrom
docs/adr-tokens-beta-export-surface
Jul 21, 2026
Merged

docs: add ADR for temporary next subpaths during eds-tokens beta#5194
pomfrida merged 1 commit into
mainfrom
docs/adr-tokens-beta-export-surface

Conversation

@pomfrida

Copy link
Copy Markdown
Collaborator

Summary

Documents the decision (already in effect since PR #5180) to publish the Tokens Studio pipeline output under temporary additive ./next/{css,dtcg,ts}/* subpaths during the eds-tokens beta, injected into files/exports at publish time — instead of replacing the legacy build on the final specifiers immediately, or asking testers to install two package versions side by side.

Contents

  • documentation/adr/0009-temporary-next-subpaths-for-eds-tokens-beta.md — full context, the three options considered, and the exit plan: when the last /next component has migrated to the new variable names, a beta release drops the legacy build/ output and moves the Tokens Studio output onto the final specifiers — inside the beta line, before graduation, so at least one beta exposes the exact 3.0.0 export surface.
  • .github/workflows/publish_tokens.yaml — the comment above the publish-time injection now describes the full lifecycle and links the ADR.
  • packages/eds-tokens/src/tokens/README.md — same lifecycle note and ADR link for anyone reading the generated-output docs.

Notes

  • Docs/comments only — no behaviour change; the injection itself landed in ci: set up automatic beta releases for eds-tokens #5180.
  • One open decision is called out in the ADR's consequences: the final specifier layout (granular ./css/* only, or also a bundled convenience entry) must be settled before the flip.

@pomfrida pomfrida self-assigned this Jul 20, 2026
@pomfrida

Copy link
Copy Markdown
Collaborator Author

@claude review

@claude

claude Bot commented Jul 20, 2026

Copy link
Copy Markdown

Claude finished @pomfrida's task in 1m 8s —— View job


Review: docs — ADR for temporary next/* subpaths during eds-tokens beta

Docs/comments-only PR. I read the diff and verified every factual claim and cross-reference against the repo.

Verification results — all pass:

  • ADR numbering — 0009 is the next free number; 0008 exists, no collision.
  • Header format (Status / Date / Decision makers) matches the ADR template and sibling ADRs (0007, 0008).
  • ADR-0008 reference resolves — title "Generate TypeScript tokens by combining the Tokens Studio DTCG and CSS exports", consistent with the "how the TS output under next/ts/* is generated" description.
  • README relative link ../../../../documentation/adr/0009-… — 4 hops from packages/eds-tokens/src/tokens/README.md lands at repo root; matches the depth of the existing TOKENS_STUDIO.md link right below it. Correct.
  • "the exports map in git stays legacy-only" — confirmed: package.json exports has ./css/variables./build/css/variables.min.css and no ./next/* entries.
  • publish_tokens.yaml comment is accurate to the injection it sits above and now links the ADR.

Assessment

This is a clean, well-structured ADR. The three options are laid out fairly (each with genuine pros and cons rather than strawmen), the decision drivers tie directly into the chosen option, and — importantly — it captures the exit plan and the one remaining open decision (bundled convenience entry vs. granular ./css/* only) rather than leaving them implicit. Documenting an already-in-effect decision (#5180) retroactively is appropriate here and the PR body is upfront about it.

Minor observations (non-blocking, optional)

  1. Status: Accepted vs. an open sub-decision. The consequences list the final specifier layout as still-open ("must be made before the flip"). Accepted is right for the additive-subpaths decision itself, so this is fine — just worth confirming that follow-up gets its own tracking (an issue link, or a future ADR) so the open item doesn't get lost. Everything needed to pick it up later is captured here, so this is a nicety, not a gap.

  2. Related section link styles are mixed. ADR-0008 and the README/TOKENS_STUDIO entries use Markdown links, while publish_tokens.yaml is bare inline code. Intentional (it's not a linkable doc from within the repo docs site the same way), and harmless — flagging only for consistency-minded reviewers.

  3. Illustrative variable names (--eds-background-container-*, --eds-density-spacing-*, --eds-family-ui) in the Context section are examples, not an exhaustive contract — reads clearly as such, no change needed.

Verdict

No correctness, accessibility, or convention issues. Cross-references and paths are all valid. The two observations above are optional polish. Ship-ready as documentation. ✅
docs/adr-tokens-beta-export-surface

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant