From afcf4458720b999f1ee7ecfb881fc40fe00d7fa6 Mon Sep 17 00:00:00 2001 From: Claude Date: Wed, 30 Sep 2026 20:24:21 +0000 Subject: [PATCH] Explain per-repository setup and the demo lane in the README Say that SStack is installed into each repository rather than uploaded as a Claude app skill, list the one-time setup (installer, dependencies and Chromium, board, project registry, Jira and GitHub connectors), and show a /sstack-demo example alongside /sstack. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01HSV4zUy6rF1vgHFSyUmuva --- README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/README.md b/README.md index 692488b..21ad233 100644 --- a/README.md +++ b/README.md @@ -134,6 +134,24 @@ handoff, recovery and merge rules. ## Install into a repository +SStack is installed into each repository you want Claude to work in, not uploaded +as a standalone skill in the Claude app. Its skills call scripts and read +configuration from that repository (`tools/sstack/`, `projects.json`, `.sstack.json`) +and act on its Git, GitHub and Jira, so they need the repository's files. + +Setup, once per repository: + +1. Run the installer below and commit the installed files. +2. Install the development dependencies with the same interpreter you will use for + checks: `pip install -r tools/sstack/requirements-dev.txt`, then + `python -m playwright install chromium` where Chromium is not preinstalled. + For cloud sessions, put both commands in the environment's setup script. +3. [Set the PM board](#set-or-change-the-pm-board) with `control.py board set`. +4. [Register the project](#register-projects-and-verification) and its checks in + `tools/sstack/projects.json`; unknown changed paths block verification. +5. Connect the host's Jira and GitHub access, such as the Atlassian and GitHub + connectors in Claude, before asking the PM to post tickets or open PRs. + Requires Git, Python 3.9+ and a filesystem that supports symlinks. Clone SStack: ```sh @@ -159,6 +177,17 @@ Open **that repository** in Claude Code or Codex and start a fresh session: Start with manual holdings entry and show allocation by asset class. ``` +For a stakeholder preview rather than delivery, use the demo lane: + +```text +/sstack-demo Show allocation by asset class for projects/portfolio to the finance team. +``` + +It writes a short script, builds on a `demo/*` branch, checks each step with +`ui_eval.py record` (local app) or `run` (hosted app) plus a visual review, and +either promotes the approved demo into tickets or archives it. See +[scripted UI evaluation](tools/sstack/skills/sstack-verify/references/ui-eval.md). + In Codex, use `$sstack` or say `PM: `. Claude Code uses `/sstack`. If discovery is unavailable, ask the agent to read `tools/sstack/skills/sstack/SKILL.md`. Local repository skills are not automatically