docs: align bundle.md example with real umbel build output#24
Merged
Conversation
The resolved-bundle.md example in docs/bundles-spec.md diverged from the emitter in ways that could mislead consumers parsing bundle.md: wrong frontmatter key order, flow-style lists, de-qualified refs, no hooks/ settings fields, and an always-shown mergeMcp. Regenerate the block verbatim from `umbel build` output (yaml block-style lists, fixed key order name/hash/description/skills/agents/hooks/mcps/ mergeMcp?/settings?, qualified <source>/<leaf> refs, hooks + settings) and single-space the invocation to match formatClaudeInvocation. Add a note documenting the key order, the conditional fields, and that refs stay qualified.
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.
Closes #10
What
The resolved-
bundle.mdexample indocs/bundles-spec.md("Self-describingbundle.md") diverged from whatumbel buildactually emits, in ways that could mislead machine consumers parsingbundle.md. Regenerate the example block verbatim from real output and add a note documenting the contract.Discrepancies fixed (spec → actual)
name, description, skills, agents, mcps, mergeMcp, hash; now matches the emitter'sname, hash, description, skills, agents, hooks, mcps[, mergeMcp][, settings](resolvedFrontmatterinsrc/bundle/compile.ts).skills: [base-skill, pandas-cheatsheet]); now keeps qualified<source>/<leaf>refs as actually emitted, with an explicit note that they stay qualified (the cache dirs use canonical names; thebundle.mdrefs do not).[a, b]; now block-style (one-per line) — that's whatyaml'sstringifyproduces.hooksfield: added (was omitted).mergeMcp/settings: documented as appearing only when set / non-empty (no longer always-shownmergeMcp: false); example now includes asettingsblock.formatClaudeInvocation(was aligned columns).Verification
yamlstringifyoverresolvedFrontmatter's output — byte-faithful.computeClaudeArgs+formatClaudeInvocation.test/unit/bundle/compile.test.ts: 32/32 pass.Scope
Docs only — the emitter is unchanged (the example follows the code, per the issue). The stale "Implementation status" section is out of scope (tracked in #8).