Skip to content

Commit 94c2961

Browse files
authored
docs: add Sentova as a worked custom-name adapt example (#108)
Document the household pest-monitor "Sentova" spec across the three doc surfaces as a worked example of the custom-project-name path. Verified 2026-05-25 (agent 0.2.1, VISUAL=0): generate overall PASS, walked on iOS + Android via the plugin's generate-app + walk-app skills. - plugin/README.md: full generate -> walk-app session with the project name passed in plain language ("project name is Sentova"). - README.md: Usage example tying --project-name to the plugin/MCP plain-language form; kept out of the VISUAL=2 matrix table. - docs/SPEC.md: add the household pest-sighting log to the SS4 adapt-path variants. Framed accurately as an *adapt* (keeps the ItemTag toggle, renamed/extended), not a replace; planner rename targets vary run to run, so mappings are cited as one run's pick.
1 parent f23e978 commit 94c2961

3 files changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,6 +117,12 @@ npx nativeapptemplate-agent "a walk-in clinic queue for small veterinary practic
117117
npx nativeapptemplate-agent "a restaurant waitlist for casual dining"
118118
npx nativeapptemplate-agent "a personal task tracker with due dates"
119119

120+
# Name the project explicitly (sets display name + output slug, independent of the
121+
# domain rename). The plugin/MCP path accepts the same intent in plain language —
122+
# "…detection. project name is Sentova." — mapped to the projectName argument.
123+
npx nativeapptemplate-agent "a two-device home monitor for household pest detection" --project-name="Sentova"
124+
# → out/sentova/ · Sentova.xcodeproj · "Sentova API"; adapts ItemTag (e.g. Shop→Household, ItemTag→Sighting)
125+
120126
# Generated output appears under ./out/<slug>/
121127
tree ./out/clinic-queue/
122128
# ├── rails/ ← Rails 8.1 API, git-initialized, buildable

docs/SPEC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ The agent performs three clean operations against this substrate.
110110

111111
**Operation 2 — Adapt or replace the domain module.**
112112

113-
- *Adapt path* (walk-in-queue variants like clinic queue, restaurant waitlist, salon walk-ins): keep `ItemTag`, rename to the variant's terminology, preserve the two-state toggle (`Idled``Completed`) and its transition logic. Variants that genuinely need a three-state lifecycle (e.g., a clinic queue wanting a distinct "in-service" state) extend the state machine rather than replace it — the planner decides whether to preserve, extend, or replace the states based on the NL spec.
113+
- *Adapt path* (walk-in-queue variants like clinic queue, restaurant waitlist, salon walk-ins, household pest-sighting log): keep `ItemTag`, rename to the variant's terminology, preserve the two-state toggle (`Idled``Completed`) and its transition logic. Variants that genuinely need a three-state lifecycle (e.g., a clinic queue wanting a distinct "in-service" state) extend the state machine rather than replace it — the planner decides whether to preserve, extend, or replace the states based on the NL spec.
114114
- *Replace path* (non-queue SaaS like task tracker, simple CRM, inventory): strip `ItemTag` end-to-end, insert a new primary resource with equivalent coverage (migration + model + controller + policy + serializer + iOS/Android screens + state transitions if applicable).
115115

116116
The planner sub-agent decides which path to run based on the NL spec.

plugin/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,23 @@ Then in the session:
6969
/nativeapptemplate-agent:generate-app a walk-in queue for a barbershop
7070
```
7171

72+
The two skills compose end-to-end — generate, then walk what you generated. A
73+
full session, including a **custom project name passed in plain language**:
74+
75+
```
76+
/nativeapptemplate-agent:generate-app a two-device home monitor for household pest detection. project name is Sentova.
77+
/nativeapptemplate-agent:walk-app sentova ios
78+
/nativeapptemplate-agent:walk-app sentova android
79+
```
80+
81+
The `project name is Sentova` clause sets the display name and output slug
82+
(`out/sentova/`, `Sentova.xcodeproj`, `Sentova API`) independently of the domain
83+
rename the planner chooses. This spec is an **adapt** of the queue toggle — it
84+
keeps `ItemTag` and renames it (one run: `Shop → Household`, `Shopkeeper →
85+
Resident`, `ItemTag → Sighting`, states `Idled → Active` / `Completed →
86+
Resolved`); the planner's exact targets vary run to run. Verified 2026-05-25
87+
(agent 0.2.1): both specs generate with overall PASS, walked on iOS + Android.
88+
7289
After editing plugin files, run `/reload-plugins` to pick up changes. Confirm the
7390
skill is loaded via `/help` and the MCP server via `/mcp`.
7491

0 commit comments

Comments
 (0)