Skip to content

Commit 2611bb8

Browse files
docs: add Cursor prototype contributor setup to README and hub guide
Adds a "Contributing a prototype" section to README.md with the four-step Cursor-first workflow (clone, open in Cursor, start dev server, chat prompt). Updates the hub contributor guide to include a "Start the dev server" step and an explicit "Create your prototype" step with the opening chat prompt, so designers know exactly what to type in Cursor to kick off the skill. Co-authored-by: Cursor <cursoragent@cursor.com>
1 parent 407ca08 commit 2611bb8

2 files changed

Lines changed: 65 additions & 1 deletion

File tree

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,34 @@ openshift-origin-design/
3939

4040
Edit Markdown under `designs/`, `conventions/`, or `research/`. The published site is built from the upstream [openshift/openshift-origin-design](https://github.com/openshift/openshift-origin-design) GitHub Pages configuration.
4141

42-
### New interactive prototype
42+
### Contributing a prototype
43+
44+
The fastest way to add a prototype is with **Cursor** and the built-in skill. No memorizing manifest fields or npm scripts.
45+
46+
1. **Clone the repo**
47+
```bash
48+
git clone git@github.com:matthewcarleton/openshift-origin-design.git
49+
cd openshift-origin-design
50+
```
51+
52+
2. **Open in Cursor**`File → Open Folder`, select the `openshift-origin-design/` directory.
53+
54+
3. **Start the dev server**
55+
```bash
56+
cd hub && npm run dev
57+
```
58+
Opens the prototype hub at [http://localhost:5173](http://localhost:5173).
59+
60+
4. **Create your prototype** — in Cursor's chat panel, type:
61+
> I want to create a prototype
62+
63+
Cursor will walk you through everything: product area, Jira ticket, persona, design notes, design doc link, and recording link.
64+
65+
The repo ships with a `prototype-contributor` skill at `.cursor/skills/prototype-contributor/` that loads automatically when you open this folder in Cursor. It handles branching, scaffolding, registering the prototype in the hub, and opening a pull request.
66+
67+
### New interactive prototype (manual)
68+
69+
If you prefer working without the Cursor skill:
4370

4471
1. Work in `hpux-prototypes/` (see `guides/` for architecture and setup).
4572
2. Scaffold from the template: `npm run create-prototype` (runs `scripts/create-prototype.cjs`).

hub/src/App.tsx

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -906,6 +906,43 @@ function HubContributingPage() {
906906
<em>I need to add to the design repo</em>.
907907
</Content>
908908

909+
<SectionSpacer />
910+
<Title headingLevel="h3" size="xl">
911+
Start the dev server
912+
</Title>
913+
<Content component={ContentVariants.p} style={{ ...STEP_GAP, ...MW }}>
914+
Open Cursor&apos;s built-in terminal (<strong>Terminal → New Terminal</strong>) and run:
915+
</Content>
916+
<Content component={ContentVariants.p} style={{ ...STEP_GAP, ...MW }}>
917+
<Code>cd hub && npm run dev</Code>
918+
</Content>
919+
<Content component={ContentVariants.p} style={{ ...STEP_GAP, ...MW }}>
920+
This starts the prototype hub at{" "}
921+
<a href="http://localhost:5173" target="_blank" rel="noopener noreferrer">
922+
http://localhost:5173
923+
</a>
924+
. Keep it running while you work — changes appear automatically without a page refresh.
925+
</Content>
926+
927+
<SectionSpacer />
928+
<Title headingLevel="h3" size="xl">
929+
Create your prototype
930+
</Title>
931+
<Content component={ContentVariants.p} style={{ ...STEP_GAP, ...MW }}>
932+
With the dev server running, open Cursor&apos;s chat panel and type:
933+
</Content>
934+
<Content
935+
component={ContentVariants.p}
936+
style={{ ...STEP_GAP, ...MW, fontStyle: "italic", paddingLeft: "var(--pf-t--global--spacer--md)", borderLeft: "3px solid var(--pf-t--global--border--color--default)" }}
937+
>
938+
I want to create a prototype
939+
</Content>
940+
<Content component={ContentVariants.p} style={{ ...STEP_GAP, ...MW }}>
941+
The <strong>prototype-contributor</strong> skill will ask you for: product area, Jira ticket, persona, design notes,
942+
design doc link, and recording link — then scaffold the prototype, register it in the hub manifest, and guide you
943+
through committing and opening a pull request.
944+
</Content>
945+
909946
<SectionSpacer />
910947
<Title headingLevel="h3" size="xl">
911948
Create your branch

0 commit comments

Comments
 (0)