loadout-ai 0.9.2 → 0.9.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,135 @@
1
+ # README and unified hero design
2
+
3
+ ## Goal
4
+
5
+ Make Loadout understandable to a first-time visitor in under 30 seconds, give
6
+ that visitor a safe first success in under five minutes, and provide one
7
+ shareable product image that explains the complete workflow.
8
+
9
+ The target reader is a developer who uses at least one AI coding agent and may
10
+ use Claude Code and Codex together. The README should assume no knowledge of
11
+ Loadout's internal terminology.
12
+
13
+ ## Reference lessons
14
+
15
+ - [Graphify](https://github.com/Graphify-Labs/graphify) leads with one concrete
16
+ outcome, reaches the install command immediately, shows what the command
17
+ produces, and moves detail below the first success.
18
+ - [Wander Agent](https://github.com/VirajMishra1/wander-agent) uses plain
19
+ language, copyable examples, visible outcomes, and setup paths organized by
20
+ the tool the reader already uses.
21
+
22
+ Loadout will adopt those information-design principles without copying their
23
+ text or structure verbatim.
24
+
25
+ ## Unified hero image
26
+
27
+ Create one 16:9, white-background, hand-drawn infographic in the visual style
28
+ of the two current product diagrams. It must remain legible when rendered at
29
+ 960 pixels wide on GitHub and when used as an X link preview.
30
+
31
+ The layout has two related lanes:
32
+
33
+ 1. The extension lifecycle: **Discover -> Curate -> Activate**.
34
+ - Discover: `skills • tools • MCP`
35
+ - Curate: `screened • pinned • reversible`
36
+ - Activate: `right tools for this repo`
37
+ - The curator skill is represented inside the Curate stage, not as a sixth
38
+ unrelated product concept.
39
+ 2. The two-agent workflow: **Claude Code <-> Loadout <-> Codex**.
40
+ - Handoff: `durable tasks + bundled context`
41
+ - Coordinate: `ownership • contracts • decisions`
42
+
43
+ Use the exact headline `YOUR TOOLS. YOUR AGENTS. ONE LOADOUT.` and the exact footer
44
+ `Preview every change • Roll back anytime • Full audit trail`.
45
+
46
+ Use restrained purple, blue, orange, and green accents with dark readable
47
+ lettering. Avoid gradients, tiny explanatory prose, fake UI screenshots,
48
+ unsupported metrics, star counts, and absolute novelty claims. The image
49
+ should communicate the combined workflow rather than claim that no related
50
+ project exists.
51
+
52
+ Generate the bitmap with the built-in image generator, inspect it for text and
53
+ layout accuracy, and save the accepted result as a new versioned asset under
54
+ `docs/assets/`. Preserve the existing two images as historical assets unless a
55
+ later cleanup explicitly removes them.
56
+
57
+ ## README information architecture
58
+
59
+ The README is a tutorial-first front page with reference material below it.
60
+ Use this order:
61
+
62
+ 1. Centered project name, the truthful value proposition **Manage skills for
63
+ 12 coding agents. Hand off and coordinate work between Claude Code and
64
+ Codex.**, badges, and the unified hero.
65
+ 2. **Try it in 30 seconds**: install Loadout, preview the Stable loadout, and
66
+ explain that the preview command changes no agent files. Do not imply that
67
+ the preceding global npm installation changes nothing.
68
+ 3. **What Loadout does**: five short capabilities—discover, curate, activate,
69
+ handoff, coordinate—with one outcome each.
70
+ 4. **Use Claude Code and Codex together**: a minimal handoff example followed
71
+ by a minimal coordination example. State clearly that this is structured
72
+ shared project state, not a merged context window or uninterrupted model
73
+ conversation.
74
+ 5. **Try these prompts**: plain-language requests a user can paste into an
75
+ agent after installing the curator and handoff skills.
76
+ 6. **Install and choose your agent**: the recommended npm installation first,
77
+ the preview and apply commands, then `loadout status` as a concrete success
78
+ check. Follow with concise agent-specific guidance and links to detailed
79
+ documentation.
80
+ 7. **Safety and trust**: preview-first behavior, pinned sources, secret-redacted
81
+ bounded bundles, snapshots, rollback, and the audit trail.
82
+ 8. **Proof and demo**: keep the clickable YouTube thumbnail because it is a
83
+ playable demonstration, not a second product explainer. Keep factual claims
84
+ tied to the existing evidence manifest and generated discovery block.
85
+ 9. **Reference**: compact command table, supported agents, profiles, and links
86
+ to full guides.
87
+ 10. **Community**: contribution, security, attribution, and license links.
88
+
89
+ The README will use only the new unified product infographic. Existing product
90
+ diagrams will no longer be embedded. The YouTube preview and small status
91
+ badges are exempt because they serve navigation and proof rather than explain
92
+ the product architecture.
93
+
94
+ ## Writing rules
95
+
96
+ - Lead with the outcome, then show the command, then explain the machinery.
97
+ - Use short sentences and familiar words.
98
+ - Keep the recommended path visible; move edge cases to linked guides.
99
+ - Prefer one realistic command block over several near-duplicates.
100
+ - Explain `handoff` and `coordinate` separately before contrasting them.
101
+ - Put the optional Loadout skill installation before natural-language prompts
102
+ that depend on those skills.
103
+ - Do not describe coordination as shared memory, a merged context window, or
104
+ agents talking continuously.
105
+ - Do not use hype words such as revolutionary, game-changing, or first-ever.
106
+ - Keep the README within the existing 425-line test budget and aim materially
107
+ below it.
108
+
109
+ ## Validation
110
+
111
+ - Update README tests to require exactly one local product explainer image and
112
+ its complete alt text while allowing the remote YouTube thumbnail and badges.
113
+ - Preserve generated README marker pairs and evidence-backed claims.
114
+ - Run the focused README test, README end-to-end journey, documented-command
115
+ check, evidence check, formatting check, and full project verification.
116
+ - Render or inspect the new hero at full size and at the README display width;
117
+ reject it if any required text is misspelled or visually cramped.
118
+ - Verify every documented command against the current CLI before publishing.
119
+
120
+ ## Out of scope
121
+
122
+ - Changing Loadout runtime behavior or the coordination protocol.
123
+ - Claiming market uniqueness or adding unverified benchmarks.
124
+ - Removing detailed guides that advanced users already rely on.
125
+ - Publishing a release or social post as part of this documentation change.
126
+
127
+ ## Two-agent review outcome
128
+
129
+ A bounded Claude Code and Codex review agreed on the central changes: unify the
130
+ product identity, move the safe preview above feature detail, remove repeated
131
+ handoff demonstrations and the abridged transcript, show five capabilities in
132
+ one compact section, and keep one explainer image. It also identified two copy
133
+ risks now resolved by this spec: do not imply universal agent compatibility,
134
+ and scope the “nothing changes” promise to the preview command rather than the
135
+ global package installation.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "loadout-ai",
3
- "version": "0.9.2",
3
+ "version": "0.9.4",
4
4
  "private": false,
5
5
  "license": "MIT",
6
6
  "description": "The package manager for AI coding agent extensions",