docs(repo): shine the front door — retro banner + zero-assumptions README (Cycle 13)#15
Merged
Merged
Conversation
…ADME (Cycle 13) Make the repo's front door welcoming to a zero-assumptions audience (including non-technical, nostalgia-driven visitors who may never have heard of Microsoft Agent). Docs/README/asset only — no code change; CI stays green. - assets/banner.svg: original retro Win9x-window banner (teal desktop, raised silver chrome, navy gradient title bar, generic speech balloon). Ships NO Microsoft/L&H imagery, no character pixels (IP rule holds). Drawn sparkles (not font glyphs) + own opaque background → crisp and light/dark-safe on GitHub. - README.md: full rewrite to the parked Vision & docs spec's voice + layout — plain-language "What is this?" + MS Agent history, "Try it in 60 seconds" (docker compose up mash), tiered onboarding (browser voice main path; authentic TruVoice an opt-in upgrade), honest "what you supply", developer pointer, credits. Nostalgia is deletable seasoning (hook + tagline + one aside). Minimal honest badges (no dead npm/CI). Later docs pages signposted at their canonical paths. - docs/cycles/cycle-13-repo-shine.md: the cycle (build-now/signpost table) + the paste-ready GitHub description + topics + social-preview PNG export steps. - docs/decisions/0025-repo-front-door.md: ADR for the front-door approach. Out of scope (signposted only): docs/ explainer + install + dev pages, the Playwright GIF/screenshot pipeline + gallery, community files, hosted demo deploy. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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.
Cycle 13 — repo shine (banner + README + GitHub metadata)
The build is feature-complete; this makes the front door welcoming to a zero-assumptions audience — including non-technical, nostalgia-driven visitors who may never have heard of Microsoft Agent. Docs/README/asset only — no code change; CI stays green.
Voice/structure follow the parked Vision & docs spec (the project's north star): assume nothing; nostalgia is deletable seasoning, never the spine; tiered onboarding with the Wine/Docker voice path always off the main road.
Spec:
docs/cycles/cycle-13-repo-shine.md· decision:ADR-0025What changed
assets/banner.svg(new) — original retro Win9x-window banner (teal desktop, raised silver chrome, navy gradient title bar, generic speech balloon). No Microsoft/L&H imagery, no character pixels (IP rule holds). Drawn sparkles (not font glyphs) + its own opaque background → crisp and light/dark-safe on GitHub.README.md(rewrite) — plain-language "What is this?" + MS Agent history, "Try it in 60 seconds" (docker compose up mash→localhost:8090), authentic voice as a clearly-labeled opt-in upgrade, honest "what you supply", a developer pointer + correctedcreateAgentsnippet, and credits. Minimal honest badges (no dead npm/CI). Every later docs page is signposted (coming soon) at its canonical path, so future cycles drop pages in with zero link churn.docs/cycles/cycle-13-repo-shine.md(new) — the cycle, the build-now/signpost table, and the paste-ready GitHub metadata + PNG export steps.docs/decisions/0025-repo-front-door.md(new) — ADR for the front-door approach (sets the voice precedent for later docs cycles).✅ Apply these GitHub settings (I can't set repo settings — please paste)
Description:
Topics (20, the gear by "About"):
Social preview (optional): no SVG rasterizer was available in the sandbox (and a docs cycle won't add a dependency), so export the 1280×640 PNG yourself and upload it under Settings → General:
rsvg-convert -w 1280 -h 640 assets/banner.svg -o assets/banner-social.png # or: npx --yes svgexport assets/banner.svg assets/banner-social.png 1280:640Homepage: leave blank until a live demo is deployed.
Verification
pnpm -r typecheck && pnpm -r test && pnpm lint && pnpm format(246 tests; Markdown is prettier-ignored by design, SVG skipped). No code touched.code-reviewer: scope (zero code change), IP (banner is original, no MS imagery), voice discipline (nostalgia deletes cleanly leaving the instructional spine intact), links (everydocs/...either exists or is marked coming), banner robustness. One should-fix applied — thecreateAgentexample now uses the realArrayBuffersignature.Out of scope (signposted only): the
docs/explainer/install/dev pages, the Playwright GIF/screenshot pipeline + gallery, community files, the hosted demo deploy.Does not merge.
🤖 Generated with Claude Code