From 7b51d50da67ba04aefc084b09a2b892781dd3986 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Przemys=C5=82aw=20Galarowicz?= Date: Wed, 17 Jun 2026 17:41:19 +0200 Subject: [PATCH] chore: update documentation --- CHANGELOG.md | 9 +++++++++ README.md | 2 +- docs/getting-started.md | 4 ++-- docs/reference/pharn-config.md | 8 ++++---- 4 files changed, 16 insertions(+), 7 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index b022f9c..14efeb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -13,6 +13,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Dependabot config, markdownlint for docs, an aggregate `npm run check` script, and an enforced test-coverage gate in CI. +### Changed + +- Docs: surfaced the new optional `/pharn-spec` stage (intent capture before `/pharn-plan`) in + getting-started and the `pharn-pipeline` module description, matching `pharn-oss`. No CLI code + change — `/pharn-spec` ships transparently via the existing whole-module install from `main`. +- Docs: completed the getting-started day-to-day loop with `/pharn-regress` and refreshed the + `pharn.config.json` example module versions to match the current `pharn-oss` manifest + (`skillsVersion` 0.70.0). + ## [0.2.0] — 2026-06-11 Realigned the CLI with the current `pharn-dev/pharn-oss`, which is now a diff --git a/README.md b/README.md index 15d61f7..37a5ae6 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ PHARN ships as **modules** (subfolders of the pharn-oss repo). `pharn-core` is r | Module | What you get | | ------ | ------------ | | `pharn-core` | Constitution, markdown memory bank, privacy-shield + constitution-guard hooks, base skills | -| `pharn-pipeline` | The plan → grill → build → regress → verify → ship pipeline | +| `pharn-pipeline` | The spec → plan → grill → build → regress → verify → ship pipeline | | `pharn-review` | `/pharn-review` with 13 context lenses + fingerprint ledger | | `pharn-audits` | 8 standalone audits (privacy, security, a11y, supply-chain, …) | | `pharn-stack-nextjs` | Next.js + Supabase + Better Auth + Drizzle stack pack (pulls in the React base) | diff --git a/docs/getting-started.md b/docs/getting-started.md index 7069a5b..2e1c6c1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -85,9 +85,9 @@ See [pharn.config.json](reference/pharn-config.md) for the exact schema. ## After init 1. Open **Claude Code** in the project directory. -2. Run **`/pharn-plan`** to plan your first feature. +2. Run **`/pharn-plan`** to plan your first feature. For a fuzzy or larger feature, run **`/pharn-spec`** first to pin the intent and scope — it's optional and feeds `/pharn-plan`. -The day-to-day loop: `/pharn-plan → /pharn-grill → /pharn-build → /pharn-verify → /pharn-review → /pharn-ship`. +The day-to-day loop: `/pharn-plan → /pharn-grill → /pharn-build → /pharn-regress → /pharn-verify → /pharn-review → /pharn-ship` (prepend `/pharn-spec` for features whose scope needs nailing down first). ## Next steps diff --git a/docs/reference/pharn-config.md b/docs/reference/pharn-config.md index 17c1c9e..981c5b7 100644 --- a/docs/reference/pharn-config.md +++ b/docs/reference/pharn-config.md @@ -26,15 +26,15 @@ The three `schemaVersion 2` fields are **additive** — installs against an olde ```json { "pharnVersion": "0.2.0", - "skillsVersion": "0.69.0", + "skillsVersion": "0.70.0", "repo": "pharn-dev/pharn-oss", "commit": "daa06788…", "constitution": "standard", "modules": [ { "name": "pharn-core", "version": "0.2.0" }, - { "name": "pharn-stack-react", "version": "0.1.1" }, - { "name": "pharn-stack-nextjs", "version": "0.30.0" }, - { "name": "pharn-pipeline", "version": "0.5.0" }, + { "name": "pharn-stack-react", "version": "0.1.2" }, + { "name": "pharn-stack-nextjs", "version": "0.31.0" }, + { "name": "pharn-pipeline", "version": "0.6.0" }, { "name": "pharn-review", "version": "0.4.0" }, { "name": "pharn-audits", "version": "0.11.1" } ],