Skip to content

docs: branded, on-brand READMEs for all 5 published packages#18

Merged
brentrager merged 1 commit into
mainfrom
package-readmes
Jun 24, 2026
Merged

docs: branded, on-brand READMEs for all 5 published packages#18
brentrager merged 1 commit into
mainfrom
package-readmes

Conversation

@brentrager

Copy link
Copy Markdown
Contributor

Problem

The registry pages — npm, PyPI, NuGet, crates.io, and pkg.go.dev — were showing empty / plain / un-branded READMEs for the five published smooth-operator-core packages. The repo's root README is beautifully branded; the per-package files that registries actually render were not.

What this does

Gives every published package a README that matches the repo's glowed-up branding, using the root README.md as the voice/layout template:

  • Banner on top (per-language, absolute raw.githubusercontent.com URL)
  • Badge row — Smoo AI platform / MIT / hosted lom.smoo.ai, plus a per-ecosystem registry badge (npm / PyPI / NuGet / crates.io / pkg.go.dev) and a language badge
  • Blockquote tagline, the "it's the engine, not a notebook demo" / "verified, not vibe-coded" voice
  • Install + Quickstart (verified hello-agent for that language) + Features (the full parity surface) + Streaming note + Part of Smoo AI + Links + License

Files (the file each registry reads)

Registry File Wired via
crates.io rust/smooth-operator-core/README.md Cargo.toml readme
npm typescript/core/README.md (new) package root
PyPI python/core/README.md pyproject.toml readme
NuGet dotnet/core/README.md csproj ..\README.md + PackageReadmeFile
pkg.go.dev go/core/README.md (new) package dir

Also adds per-language banners (banner-typescript/python/go/dotnet.png) rendered from the existing banner.svg with the language-specific subtitle.

Correctness

  • Every image and link is an absolute URL — registries don't resolve relative paths. Verified: no ](. / src=". relative refs.
  • Every quickstart mirrors the verified hello-agent example from docs/Polyglot-Engines.md, cross-checked against each engine's source (SmoothAgent/MockLlmProvider symbols, run/run/Run/RunAsync, pushText/push_text/PushText).
  • Streaming notes use the real per-language method: run_with_channel (Rust), runStream (TS), run_stream (Py), RunStream (Go), RunStreamingAsync (C#).

Note

Additive only — no version bumps, no publish. Re-publishing is handled separately by the lead.

🤖 Generated with Claude Code

@changeset-bot

changeset-bot Bot commented Jun 24, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2dfe3f7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

…I/NuGet/crate/Go)

The registry pages (npm, PyPI, NuGet, crates.io, pkg.go.dev) showed empty or
plain, un-branded READMEs. This gives each published package a README that
matches the repo's glowed-up branding — banner-on-top layout, shields.io badge
row (incl. a per-ecosystem registry badge), the blockquote tagline, the
"it's the engine, not a notebook demo" / "verified, not vibe-coded" voice, the
parity feature surface, a streaming note, and the "Part of Smoo AI" + footer.

All images and links use absolute URLs (raw.githubusercontent.com for banners,
github.com / smoo.ai for links) so they render correctly off-repo on every
registry. Every quickstart mirrors the verified hello-agent example for that
language from docs/Polyglot-Engines.md and the engine source.

- Rust  -> rust/smooth-operator-core/README.md  (Cargo.toml readme)
- npm   -> typescript/core/README.md            (new)
- PyPI  -> python/core/README.md                (pyproject readme)
- NuGet -> dotnet/core/README.md                (csproj ..\README.md / PackageReadmeFile)
- Go    -> go/core/README.md                    (new; pkg.go.dev)

Adds per-language banners (banner-typescript/python/go/dotnet.png) rendered from
the existing banner.svg with the language-specific subtitle.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7Mn93HpqhSgEmX6tRdPAv
@brentrager brentrager merged commit c1f0ea4 into main Jun 24, 2026
5 checks passed
brentrager added a commit that referenced this pull request Jun 24, 2026
npm 0.1.0→0.1.1, PyPI 1.3.0→1.3.1, NuGet 1.3.0→1.3.1, crate 0.14.0→0.14.1.
Registries only surface the latest version's README, so a republish is needed for
the new on-brand package READMEs (#18) to appear on the storefronts.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01U7Mn93HpqhSgEmX6tRdPAv
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