Skip to content

Add AGENTS.md for teams using io and Holocene - #4075

Open
tigernaut wants to merge 4 commits into
mainfrom
consumer-agents-md
Open

tigernaut wants to merge 4 commits into
mainfrom
consumer-agents-md

Conversation

@tigernaut

@tigernaut tigernaut commented Oct 23, 2026 •

Copy link
Copy Markdown

Adds src/lib/AGENTS.md, which svelte-package copies to dist/AGENTS.md in every release package. It is written for teams using io and Holocene: which layer to pick, import paths, real props, semantic color classes and common mistakes. The contributor guidance and behavior are unchanged.

Description & motivation 💭

  • It improves the UI that agents build. Fewer invented props, fewer colors that break in dark mode, and fewer Holocene components used where io already has one.
  • It moves the io migration forward. It tells every consuming agent to prefer io.
  • Adds a point on the agent-readiness score. Consumer guidance shipped in the package moves that check from 1/2 to 2/2, taking the total from 5 to 6.

Screenshots (if applicable) 📸

n/a

Design Considerations 🎨

Drift and discoverability: there’s no one-line fix for this. Two options are to generate the io table when packaging, and to add the Cloud UI pointer we discussed. Neither blocks the PR.

Testing 🧪

How was this tested 👻

  • Manual testing
  • E2E tests added
  • Unit tests added

Steps for others to test: 🚶🏽‍♂️🚶🏽‍♀️

Checklists

Draft Checklist

Merge Checklist

Issue(s) closed

Docs

Any docs updates needed?

Adds src/lib/AGENTS.md, which svelte-package copies to dist/AGENTS.md
in every release package. It is written for teams using io and
Holocene: which layer to pick, import paths, real props, semantic
color classes and common mistakes. The contributor rules in
src/lib/io/AGENTS.md are unchanged.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
holocene Ready Ready Preview Oct 23, 2026 8:51pm UTC

Request Review

@tigernaut tigernaut changed the title Agentic Design System: Add consumer AGENTS.md to the published package Add AGENTS.md for teams using io and Holocene Oct 23, 2026
Clarify usage of components and guidelines for new work.
@tigernaut
tigernaut marked this pull request as ready for review October 23, 2026 20:35
@tigernaut
tigernaut requested a review from a team as a code owner October 23, 2026 20:35
@tigernaut
tigernaut requested a balanced review from Copilot October 23, 2026 20:38

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation-only change has two minor accuracy corrections with concrete fixes, neither of which blocks approval.

2 open issues
What changed in this PR

Adds package-consumer guidance for agents using io and Holocene, intended to ship with @temporalio/ui releases without changing runtime behavior.

Changes:

  • Documents io-first component selection and package import paths.
  • Provides prop examples, semantic color guidance, and common mistakes.
  • Points consumers to component contracts for detailed usage rules.
File Description
src/​lib/​AGENTS.md Adds consumer guidance for selecting and using io and Holocene components.

Review effort: Balanced

Comment thread src/lib/AGENTS.md Outdated
Comment thread src/lib/AGENTS.md Outdated
@tigernaut
tigernaut marked this pull request as draft October 23, 2026 20:42
Clarify definitions for Badge, Tag, Chip, and ChipStatus.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Update guidelines for using Holocene components and icon buttons.
@tigernaut
tigernaut marked this pull request as ready for review October 23, 2026 21:15

This branch was successfully deployed

1 active deployment
Preview — 85bc495d Deployed Oct 23, 2026 by vercel[bot]
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.

2 participants