docs: outsider-facing clarity pass on README + skills.json#9
Merged
Conversation
- Boundary section: drop the "Internal Sellmore orchestration" / next-campaigns-ops reference (private-repo bleed in a public README) and reframe the split as a *why* (version-lock to campaigns-os CLI/contracts) instead of an arbitrary boundary. - Replace "CPK" jargon with "Next Commerce campaign repo" in the New Campaign Setup row and boundary text — readers landing cold had no way to know what CPK meant. - Fix stale install string: pip install 29next-theme-kit → next-theme-kit, in both skills.json (prerequisites) and next-theme-dev/SKILL.md (preamble environment check). The PyPI package is next-theme-kit. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Code Review SummaryStatus: 1 Observation Found | Recommendation: Merge (with optional cleanup) Changes Reviewed
Issue Details
Files Reviewed (3 files)
Reviewed by minimax-m2.7 · 161,471 tokens |
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
Quick clarity pass on the public-facing surfaces of this repo. Three small changes:
next-campaigns-opsrepo and "internal Sellmore orchestration" — neither of which an outside developer reading this README has any context for. The new version explains why the lifecycle skills live with thecampaigns-ospackage (they're version-locked to the package's CLI and contract versions), which makes the split make sense instead of feeling arbitrary.pip install 29next-theme-kit→pip install next-theme-kit. The PyPI package isnext-theme-kit. The bad string appeared in bothskills.json(next-theme-dev prerequisites) andnext-theme-dev/SKILL.md(preamble environment check).Why
Came out of a session reviewing how the README reads to a client landing cold. The same pattern (internal/self-references bleeding into public-facing material) showed up in
campaigns-os/README.mdtoo — there's a companion PR there: NextCommerceCo/campaigns-os#50.Test plan
cat skills.json | jq '.skills[] | select(.id=="next-theme-dev").prerequisites'showsnext-theme-kit29next-theme-kitin repo:grep -r "29next-theme-kit" .returns nothing