feat: make the package ready for external use - #49
Merged
Conversation
The package is published --access public but carried license "UNLICENSED" and no LICENSE file, so nobody could legally use it. It also had no keywords, homepage or bugs URL, and the README was written for the two repos that used to vendor it. - LICENSE: MIT, and set the package `license` field to match - package.json: homepage ds.agentage.io, bugs URL, 16 keywords, git+ repo URL, description that says what the package actually is - README: rewritten for a first-time consumer - install, theme, the Tailwind @source trap, RSC contract, theming tiers, and a component table linking every category to its live page - docs/banner.svg: banner built from the real OKLCH gold scale - showcase header: copyable install command plus npm and GitHub links
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
@agentage/design-systemis published to npm with--access public, but the package carried"license": "UNLICENSED"and shipped no LICENSE file. Legally that means nobody outside the orgcould use it. It also had no
keywords(zero npm discoverability), nohomepage, nobugsURL,and a README written for the two monorepos that used to vendor the package rather than for someone
installing it for the first time.
What
Licensing
LICENSE- MIT, matching@agentage/find-mcpand the rest of the public packages.package.jsonlicenseset toMIT.npm metadata
homepage-> https://ds.agentage.io,bugs-> the issues URL.repository.urlin the conventionalgit+https://form.keywordscovering design-system / react-19 / tailwind-v4 / oklch / rsc / a11y.108-entry
exportsmap is untouched.README - rewritten on the
find-mcpmodel: banner, what-it-is, four-step getting started(install / theme / the Tailwind
@sourcetrap / first component), a component table linking eachof the eight categories to its live page, the RSC contract, theming tiers, a requirements table,
develop + release, contributing, license.
Banner -
docs/banner.svg, built from the actual OKLCH gold scale converted to sRGB.Showcase header - a copyable
npm i @agentage/design-systemchip (dogfoodingCopyButton)plus npm and GitHub links. The chip is gated at
xlso the header stays on one line at 1024px;nav labels get
whitespace-nowrap, which also fixes a pre-existing two-line wrap of"Getting started" at that width.
Verification
npm run verifygreen - type-check (src + dev + e2e), lint (0 errors; the 5 warnings arepre-existing
react-hooks/set-state-in-effectinsrc/), format, exports:check, 434 tests,build.
npx playwright testinmcr.microsoft.com/playwright:v1.62.1-noble: 43 passed, includingthe axe WCAG A/AA scans and all 11 screenshot baselines. No baseline regeneration needed - the
visual snapshots scope to content regions, not the header.
npm i @agentage/design-systemon theclipboard. Both external links resolve to the right URL with
target="_blank".Note
This does not bump the version. The metadata only reaches npm on the next
chore(release):commit - worth doing soon, since every currently published version is still marked UNLICENSED.