Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,14 @@ Index: README.md → table of projects

## What this repo is

A workspace for Figma plugins and design tooling. It currently hosts a
single active project (the former Nectar Design Toolkit and Design System
Builder projects have been removed):
A workspace for Figma plugins, design tooling, and design case studies. It
currently hosts two active projects (the former Nectar Design Toolkit and
Design System Builder projects have been removed):

| Project | Folder | Status |
|---------|--------|--------|
| Variables & Styles Extractor | [`variables-styles-extractor/`](variables-styles-extractor/) | Published on Figma Community ([1584331992332668732](https://www.figma.com/community/plugin/1584331992332668732/variables-and-styles-extractor)) |
| Project | Folder | Type | Status |
|---------|--------|------|--------|
| Variables & Styles Extractor | [`variables-styles-extractor/`](variables-styles-extractor/) | Figma plugin | Published on Figma Community ([1584331992332668732](https://www.figma.com/community/plugin/1584331992332668732/variables-and-styles-extractor)) |
| CREATIVIA | [`creativia/`](creativia/) | Design case study + planned demo | Content scaffold (v0.1.0) — Lollypop Designathon 2025, Team 6 |

---

Expand Down Expand Up @@ -54,7 +55,8 @@ banned without explicit user permission.

| You're editing | You may also touch | You must NOT touch |
|----------------|--------------------|--------------------|
| `variables-styles-extractor/**` | Root `README.md`, `.github/` if it's a security/CI change you've been asked for | — |
| `variables-styles-extractor/**` | Root `README.md`, `.github/` if it's a security/CI change you've been asked for | `creativia/**` and other project source unless explicitly asked |
| `creativia/**` | Root `README.md`, `.github/` if it's a security/CI change you've been asked for | `variables-styles-extractor/**` and other project source unless explicitly asked |
| Workspace root files (this file, README, `.gcc/`) | The project's README if cross-cutting | Per-project source unless explicitly asked |

If a future change spans more than one project folder (e.g. extracting
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Side-Kicks

A multi-project workspace for Figma plugins and design tools.
A multi-project workspace for Figma plugins, design tools, and design case studies.

📖 **AI builders start here:** [AGENTS.md](AGENTS.md) — workspace-level canonical rules.
🔒 **Reporting a vulnerability:** [`.github/SECURITY.md`](.github/SECURITY.md).
Expand All @@ -13,6 +13,7 @@ A multi-project workspace for Figma plugins and design tools.
| Project | Folder | Status | Notes |
|---------|--------|--------|-------|
| Variables & Styles Extractor | [`variables-styles-extractor/`](variables-styles-extractor/) | Published v2.1.2 · first published 17 Jan 2026 | Figma plugin · [Community page](https://www.figma.com/community/plugin/1584331992332668732/variables-and-styles-extractor) |
| CREATIVIA | [`creativia/`](creativia/) | Content scaffold v0.1.0 · working demo planned | Design case study — AI creative co‑pilot for musicians · [Lollypop Designathon 2025](https://lollypop.design/designathon-2025/), Team 6 |

---

Expand Down Expand Up @@ -54,7 +55,14 @@ side-kicks/ (this repo: tknatwork/side-kicks
│ ├── assets/ ← Plugin logo (SVG) + icon
│ ├── .github/copilot-instructions.md
│ └── docs/ ← CHANGELOG, CODING_STANDARDS, FIGMA_PLUGIN_DEVELOPMENT, etc.
└── (single active project: variables-styles-extractor)
└── creativia/ ← Project: design case study (+ planned demo)
├── AGENTS.md ← Project AI rules (canonical)
├── CLAUDE.md ← Pointer to project AGENTS.md
├── README.md ← Public-facing case study
├── LICENSE ← MIT + design-IP note
├── assets/screens/ ← Optimised screen + process gallery
├── .github/copilot-instructions.md + ISSUE_TEMPLATE/
└── docs/ ← CASE_STUDY, BRAND, ROADMAP, CHANGELOG, redirects
```

---
Expand Down
24 changes: 24 additions & 0 deletions creativia/.github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Bug report
about: Report a problem with the CREATIVIA case study or demo
title: '[BUG] '
labels: bug
assignees: ''
---

**Where**
- [ ] Case study content (README / docs)
- [ ] Screen gallery / assets
- [ ] Demo (when available)

**Describe the issue**
A clear and concise description of what's wrong.

**Expected**
What you expected to see instead.

**Screenshots**
If applicable, add screenshots.

**Additional context**
Anything else worth knowing.
22 changes: 22 additions & 0 deletions creativia/.github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an improvement to the CREATIVIA case study or demo
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

**Project**
- [x] CREATIVIA

**Is your request related to a problem? Please describe.**
A clear and concise description of the problem. Ex. "The case study is missing [...]"

**Describe what you'd like**
A clear and concise description of what you want to happen.

**Alternatives considered**
Any alternative approaches you've thought about.

**Additional context**
Anything else — references, screenshots, links.
25 changes: 25 additions & 0 deletions creativia/.github/copilot-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- === SYSTEM PAIRING ===
Consumed by: GitHub Copilot
Updated by: manual, when the canonical read order changes
Pairs with: ../AGENTS.md
Update trigger: AGENTS.md read-order or scope changes
Last verified: 2026-06-12
Index: AGENTS.md
=== END PAIRING === -->

# CREATIVIA — Copilot Instructions

> ⚠️ PROTECTED FILE — DO NOT DELETE. Rewrite if the direction changes.

This is a thin redirect. The canonical AI-builder rules are not duplicated here.

**AI builders, read in this order:**

1. [`AGENTS.md`](../AGENTS.md) — canonical project AI rules (scope, content rules, roadmap).
2. [`README.md`](../README.md) — the public case study (narrative source of truth).
3. [`docs/CASE_STUDY.md`](../docs/CASE_STUDY.md) · [`docs/BRAND.md`](../docs/BRAND.md) · [`docs/ROADMAP.md`](../docs/ROADMAP.md).

**Project is content-first.** Do not start building demo app code unless the user
asks to move to Phase 1+ (see [`docs/ROADMAP.md`](../docs/ROADMAP.md)). Stay faithful to
the Designathon submission — don't invent features or metrics. Scope: work only within
`Side-Kicks/creativia/`.
152 changes: 152 additions & 0 deletions creativia/AGENTS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,152 @@
<!-- === SYSTEM PAIRING ===
Consumed by: All AI builders (Claude Code, Cursor, Copilot, Aider, Continue, Gemini CLI, Codex)
Updated by: manual, on content or roadmap changes
Pairs with: CLAUDE.md (pointer), docs/CASE_STUDY.md, docs/BRAND.md, docs/ROADMAP.md
Update trigger: new content source absorbed, demo phase started, brand/scope change
Last verified: 2026-06-12 (initial content scaffold from Designathon 2025 submission)
Index: AGENTS.md
=== END PAIRING === -->

# AGENTS.md — CREATIVIA

> Canonical AI-builder rules for the CREATIVIA project in this folder.
> All builder LLMs read this file. [AGENTS.md is the Sourcegraph universal convention](https://agents.md).

**Project:** CREATIVIA — an AI creative co‑pilot for musicians (case study + planned portfolio demo)
**Repository:** [`tknatwork/side-kicks`](https://github.com/tknatwork/side-kicks) (this folder)
**Origin:** [Lollypop Designathon 2025](https://lollypop.design/designathon-2025/) · Team 6 · Bangalore · 8–9 Aug 2025
**Persona:** Raj, 24‑year‑old guitarist (Musician track)
**License:** [MIT](LICENSE) © 2025 Tushar Kant Naik (covers code + docs in this folder; not the team's design IP or the Lollypop brand)

---

## What this is (and is NOT)

CREATIVIA is **not a Figma plugin** — it does not share the constraints of the
sibling `variables-styles-extractor/` project. It is a **design case study**
with a **planned working demo** for the owner's portfolio site.

| It IS | It is NOT |
|-------|-----------|
| A structured record of a 24‑hour Designathon entry | A shipped product |
| Content-first: problem, persona, research, features, brand | A Figma plugin (no QuickJS/iframe constraints) |
| The home for a future static/interactive web demo | A backend service or real AI integration (yet) |

**Phase right now: content.** The working demo is a later phase — do not start
building app code unless the user asks to move to Phase 1+ (see
[`docs/ROADMAP.md`](docs/ROADMAP.md)).

---

## Read order at session start

1. **This file** (`AGENTS.md`) — scope, content rules, roadmap.
2. **`.gcc/session-memory.md`** — warm-start state (local-only; gitignored).
3. **[`README.md`](README.md)** — the public case study (source of truth for the narrative).
4. **[`docs/CASE_STUDY.md`](docs/CASE_STUDY.md)** — long-form content.
5. **[`docs/BRAND.md`](docs/BRAND.md)** — colours + type tokens.
6. **[`docs/ROADMAP.md`](docs/ROADMAP.md)** — phased plan toward the demo.

---

## Workspace scope restriction

- ✅ Allowed: `creativia/**`
- ✅ Allowed when asked: root `README.md`, `AGENTS.md`, `docs/CHANGELOG.md` (registering this project is a cross-cutting change you were asked to make)
- ❌ Forbidden without explicit user approval: other project folders (e.g. `variables-styles-extractor/`)

---

## Project structure

```
creativia/
├── AGENTS.md ← This file (canonical AI rules)
├── CLAUDE.md ← Pointer to AGENTS.md (legacy Claude Code path)
├── README.md ← Public-facing case study
├── LICENSE ← MIT (+ design-IP note)
├── assets/
│ ├── screens/ ← Optimised gallery rendered from the A4 PDF
│ └── figma/ ← Frames pulled directly from the Figma design file
├── .github/
│ ├── copilot-instructions.md
│ └── ISSUE_TEMPLATE/ ← bug + feature templates
└── docs/
├── AGENTS.md ← Redirect to ../AGENTS.md
├── CLAUDE.md ← Redirect to ../CLAUDE.md
├── CASE_STUDY.md ← Long-form content (problem → solution)
├── BRAND.md ← Brand tokens (colour + type)
├── ROADMAP.md ← Phased plan toward the working demo
└── CHANGELOG.md ← Version history (protected)
```

`.gcc/` (session memory + build log) is **gitignored** workspace-wide — keep it
local; never rely on it being committed.

---

## Content rules (Phase 0 — current)

1. **Stay faithful to the source.** The narrative comes from the Designathon
submission (problem statement, Musician persona, and the team's A4 process
document). Do not invent features, metrics, or research that weren't in the
submission. If something is uncertain, mark it `<!-- TODO -->` rather than
fabricating.
2. **Attribute honestly.** This is **Team 6's** collective work, organised into
four design pods (PM, persona & research, presentation & dashboards, graphics
— see the README). Credit the whole team and keep the owner's documented role
(presentation & dashboards + niche features) accurate; do not inflate it.
3. **Respect the Lollypop brand.** Document the entry for educational/portfolio
use; don't imply endorsement or ownership of the Lollypop/Designathon marks.
4. **Keep assets lean.** Screen images live in `assets/screens/` as optimised
JPEGs. Re-optimise (don't bloat) if you add more.
5. **One narrative, linked everywhere.** `README.md` is the canonical story;
`docs/CASE_STUDY.md` expands it. Keep them consistent — if you change a fact,
change it in both.

---

## Build rules (Phase 1+ — when the demo starts)

Follows the [workspace rules](../AGENTS.md):

| Rule | Why |
|------|-----|
| Use **`pnpm`**. Never `npm`/`npx`. `pnpm dlx` for one-shots. | Lockfile integrity across the workspace |
| Prefer **Vite + TypeScript** for the demo (static-first, deployable). | Lightweight, portfolio-friendly |
| **Pin model IDs** (no `-latest`) if/when any AI call is added. | Avoid silent behaviour change |
| Keep the demo **deployable as static** where possible. | Easy to embed in the portfolio site |
| No workspace-level CI builds this. | Each project owns its build |

Document the chosen stack in this file and `docs/ROADMAP.md` when Phase 1 starts.

---

## File-protection rules (project-scoped)

Never delete — rewrite if the content becomes wrong:

| Path | What it captures |
|------|------------------|
| `AGENTS.md` (this file) | Canonical AI rules |
| `CLAUDE.md` | Pointer for legacy Claude Code path |
| `README.md` | Public-facing case study |
| `LICENSE` | MIT + design-IP note |
| `docs/AGENTS.md`, `docs/CLAUDE.md` | Redirects (kept for tooling) |
| `docs/CASE_STUDY.md`, `docs/BRAND.md`, `docs/ROADMAP.md` | Content |
| `docs/CHANGELOG.md` | Version history (protected) |
| `.github/copilot-instructions.md` | Copilot rules |
| `assets/screens/**`, `assets/figma/**` | The source images (A4 gallery + Figma frames) |

---

## How to report a bug or vulnerability

| Kind | Channel |
|------|---------|
| Issue with this case study / demo | [GitHub Issues](https://github.com/tknatwork/side-kicks/issues/new/choose) |
| Security vulnerability | **Do not open a public issue.** Use [GitHub Private Vulnerability Reporting](https://github.com/tknatwork/side-kicks/security/advisories/new) or email `hi@tusharkantnaik.com`. See [`/.github/SECURITY.md`](../.github/SECURITY.md). |

---

*Last updated: 2026-06-12 (initial content scaffold — Designathon 2025 submission captured as a case study; working demo deferred to Phase 1+)*
28 changes: 28 additions & 0 deletions creativia/CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- === SYSTEM PAIRING ===
Consumed by: Claude Code (legacy path), tooling that hardcodes CLAUDE.md
Updated by: never (this is a redirect)
Pairs with: AGENTS.md (canonical)
=== END PAIRING === -->

# CLAUDE.md — pointer

> **The canonical AI-instruction file for CREATIVIA is [AGENTS.md](AGENTS.md).** Follow that.
>
> This file is a pointer for Claude Code's built-in file lookup and any
> tooling that still hardcodes the legacy path.
>
> AGENTS.md is the [Sourcegraph universal convention](https://agents.md).
> All builder LLMs (Claude Code, Cursor, Copilot, Aider, Continue, Gemini CLI, Codex) should read it.
>
> **Do NOT add content here.** Edits to AI-builder rules belong in [AGENTS.md](AGENTS.md).
>
> ---
>
> **Read order for new sessions inside this folder:**
>
> 1. [AGENTS.md](AGENTS.md) — Canonical project AI rules
> 2. [`.gcc/session-memory.md`](.gcc/session-memory.md) — Warm-start state (local-only, gitignored)
> 3. [`README.md`](README.md) — The public case study (narrative source of truth)
> 4. [`docs/CASE_STUDY.md`](docs/CASE_STUDY.md) · [`docs/BRAND.md`](docs/BRAND.md) · [`docs/ROADMAP.md`](docs/ROADMAP.md)
>
> The workspace-level entry point lives at the repo root: [`../AGENTS.md`](../AGENTS.md).
37 changes: 37 additions & 0 deletions creativia/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
MIT License

Copyright (c) 2025 Tushar Kant Naik

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

---

Note on design IP and the Lollypop Designathon:

The MIT license above governs the source code and documentation authored in
this folder (the case-study write-up and any future demo code).

CREATIVIA was conceived and designed by Team 6 at the Lollypop Designathon
2025 (https://lollypop.design/designathon-2025/). The original product
concept and visual design are the collective work of that team. The
"Lollypop" name, the Designathon, the provided problem statement, and the
Musician persona are the property of Lollypop Design Studio. This folder
documents Team 6's entry for educational and portfolio purposes only; the
MIT grant does not transfer any rights to the Lollypop brand or to the
team's original design IP, and implies no endorsement.
Loading