docs: branded, on-brand READMEs for all 5 published packages#18
Merged
Conversation
|
…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
edb5f5f to
2dfe3f7
Compare
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
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.
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-corepackages. 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.mdas the voice/layout template:raw.githubusercontent.comURL)Files (the file each registry reads)
rust/smooth-operator-core/README.mdCargo.tomlreadmetypescript/core/README.md(new)python/core/README.mdpyproject.tomlreadmedotnet/core/README.md..\README.md+PackageReadmeFilego/core/README.md(new)Also adds per-language banners (
banner-typescript/python/go/dotnet.png) rendered from the existingbanner.svgwith the language-specific subtitle.Correctness
](./src=".relative refs.docs/Polyglot-Engines.md, cross-checked against each engine's source (SmoothAgent/MockLlmProvidersymbols,run/run/Run/RunAsync,pushText/push_text/PushText).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