feat: add a README editor to the Create Bundle wizard - #6
Merged
Merged
Conversation
Bundles published from the web always shipped without README.md because the wizard hard-coded an empty readme on publish. Add a README step (Metadata > Assets > README > Setup > Review) mirroring the asset Contribute wizard, with a live markdown preview, a "README provided / none" row on the review step, and the README passed through to publishBundle. The README stays a sibling file and never lands in bundle.json. Edit / New version on the bundle page now seeds the wizard with the current README so a new version starts from the existing one. Persisted drafts written before this step still load (readme defaults to ''). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011nojgR3M3ZNo3BfyTZdWTz
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011nojgR3M3ZNo3BfyTZdWTz
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.
Summary
Follow-up 1 from #5 / #4. Bundles published from the web always shipped without
README.mdbecause the Create Bundle wizard hard-codedreadme: ''on publish. The publish path already supported a README; only the UI was missing. This is likely why the #4 reporter put README content into setup instructions.Changes
draft.readmethrough topublishBundle, which appendsREADME.mdto the payload. The README stays a sibling file and never lands inbundle.json.readmeadded to the draft, the persisted-draft schema (defaults to''so drafts saved before this step still load), and the edit/new-version seed.docs/bundle-readme-followups.md, the handoff notes for the three follow-ups.Tests
readmepublish argument, and that neither the reviewbundle.jsonnor the publish manifest contains areadmekey.readmeload;BundleDetailEdit / New version seedsreadmewhen present and omits it when absent.Verification
pnpm lint,pnpm typecheck,pnpm test(29 files, 295 tests) all green.npx prettier --checkclean on the touched files. Repo-wideformat:checkstill has the pre-existing CRLF noise frommain.Related
atk infoREADME rendering.🤖 Generated with Claude Code
https://claude.ai/code/session_011nojgR3M3ZNo3BfyTZdWTz