Skip to content

Commit 1023943

Browse files
committed
Reorganize repo layout for catalog, assets, and docs.
Move conferences.csv to data/, static media to assets/, document folder conventions in docs/REPO_LAYOUT.md, and update paths across the app and CI.
1 parent faacbe0 commit 1023943

15 files changed

Lines changed: 60 additions & 25 deletions

File tree

.cursor/skills/update-conference-data/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
---
22
name: update-conference-data
33
description: >-
4-
Add or update rows in conferences.csv for the Conference Tracker dashboard.
4+
Add or update rows in data/conferences.csv for the Conference Tracker dashboard.
55
Use when the user asks to add a conference, update deadlines/links/location,
66
fix missing data, verify CFP/CfT/CfW, enrich notes, or edit conference catalog
77
entries. Schema: docs/CATALOG.md. Requires web research from official sources before writing values.
88
---
99

10-
# Update conference data (`conferences.csv`)
10+
# Update conference data (`data/conferences.csv`)
1111

1212
**Schema, enums, UI mapping:** [`docs/CATALOG.md`](../../../docs/CATALOG.md) — do not duplicate column lists here.
1313
**PR workflow:** [CONTRIBUTING.md](../../../CONTRIBUTING.md).
1414

1515
## Scope
1616

17-
- **In scope:** `conferences.csv` only.
17+
- **In scope:** `data/conferences.csv` only.
1818
- **Out of scope:** `index.html` / `app.js` unless the user asks for UI changes.
1919

2020
## Before editing

.github/workflows/ci.yml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ name: CI
66
on:
77
pull_request:
88
paths:
9-
- "conferences.csv"
9+
- "data/**"
10+
- "assets/**"
1011
- "app.js"
1112
- "index.html"
1213
- "styles.css"
@@ -16,7 +17,8 @@ on:
1617
push:
1718
branches: [main]
1819
paths:
19-
- "conferences.csv"
20+
- "data/**"
21+
- "assets/**"
2022
- "app.js"
2123
- "index.html"
2224
- "styles.css"
@@ -36,9 +38,9 @@ jobs:
3638
runs-on: ubuntu-latest
3739
timeout-minutes: 5
3840
steps:
39-
- uses: actions/checkout@v4
41+
- uses: actions/checkout@v5
4042

41-
- uses: actions/setup-python@v5
43+
- uses: actions/setup-python@v6
4244
with:
4345
python-version: "3.12"
4446

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
*.pem
44
.DS_Store
55
conferences copy.csv
6-
conferences.csv.bak*
6+
data/conferences.csv.bak*
77

88
TODO.md
99

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ This project accepts updates through pull requests (PRs).
2222
git checkout -b chore/update-conference-entry
2323
```
2424

25-
2. Edit `conferences.csv` per [`docs/CATALOG.md`](docs/CATALOG.md) (schema) and [`.cursor/skills/update-conference-data/SKILL.md`](.cursor/skills/update-conference-data/SKILL.md) (research rules).
25+
2. Edit `data/conferences.csv` per [`docs/CATALOG.md`](docs/CATALOG.md) (schema) and [`.cursor/skills/update-conference-data/SKILL.md`](.cursor/skills/update-conference-data/SKILL.md) (research rules).
2626

2727
3. Validate your changes:
2828
- Check for accidental extra commas or broken CSV rows.
@@ -32,7 +32,7 @@ git checkout -b chore/update-conference-entry
3232
4. Commit:
3333

3434
```bash
35-
git add conferences.csv
35+
git add data/conferences.csv
3636
git commit -m "Update conference entry details"
3737
```
3838

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Cybersecurity Conference Tracker
22

3-
Track cybersecurity, infosec, and hacking speaking opportunities in `conferences.csv`, and view them in the static dashboard (`index.html`).
3+
Track cybersecurity, infosec, and hacking speaking opportunities in `data/conferences.csv`, and view them in the static dashboard (`index.html`).
44

55
## Screenshot
66

7-
![Conference Tracker dashboard screenshot](screenshots/app-screenshot.png)
7+
![Conference Tracker dashboard screenshot](assets/screenshots/app-screenshot.png)
88

99
## Why This Project Exists
1010

@@ -22,7 +22,7 @@ In short, this repository turns conference discovery from an ad-hoc process into
2222

2323
## No backend required
2424

25-
This project is a **static site** (HTML, CSS, JavaScript, and `conferences.csv`). There is **no** server-side app, database, or account system to deploy. Personal UI state (filters, persona mode, pipeline, saved trips) stays in **your browser** using `localStorage` and does not get sent to a server.
25+
This project is a **static site** (HTML, CSS, JavaScript, and `data/conferences.csv`). There is **no** server-side app, database, or account system to deploy. Personal UI state (filters, persona mode, pipeline, saved trips) stays in **your browser** using `localStorage` and does not get sent to a server.
2626

2727
You can use the **public deployment**, **self-host** a copy, or **run locally**—see [How to run (no backend)](#how-to-run-no-backend) below. Optional future features (accounts, verified badges, sync) would be additive; the core tracker is intended to remain usable as static files only.
2828

@@ -31,6 +31,7 @@ You can use the **public deployment**, **self-host** a copy, or **run locally**
3131
| Audience | Doc |
3232
|----------|-----|
3333
| **Catalog schema & UI** | [`docs/CATALOG.md`](docs/CATALOG.md) — columns, enums, deadlines, dashboard mapping |
34+
| **Repo layout** | [`docs/REPO_LAYOUT.md`](docs/REPO_LAYOUT.md) — folders and conventions |
3435
| **Curators / AI agents** | [`.cursor/skills/update-conference-data/SKILL.md`](.cursor/skills/update-conference-data/SKILL.md) — research workflow (points at CATALOG) |
3536
| **Pull requests** | [`CONTRIBUTING.md`](CONTRIBUTING.md) |
3637

@@ -56,15 +57,15 @@ Serve the **repository root** as static files. No runtime, build step, or databa
5657

5758
Examples:
5859

59-
- **GitHub Pages:** Enable Pages on your fork; publish the branch/folder that contains `index.html` (often the repo root). Relative paths (`./app.js`, `./conferences.csv`) work as long as the site entry URL matches your folder layout.
60+
- **GitHub Pages:** Enable Pages on your fork; publish the branch/folder that contains `index.html` (often the repo root). Relative paths (`./app.js`, `./data/conferences.csv`) work as long as the site entry URL matches your folder layout.
6061
- **Any static host or web server:** Copy the project files and point the document root at this directory.
6162
- **Object storage + CDN:** Upload the same files; keep relative paths intact.
6263

6364
Forkers get their own URL (e.g. `https://<user>.github.io/<repo>/`); the app works the same.
6465

6566
### 3. Run locally
6667

67-
Browsers block loading `conferences.csv` from `file://` pages, so use a small local HTTP server. From the project root:
68+
Browsers block loading `data/conferences.csv` from `file://` pages, so use a small local HTTP server. From the project root:
6869

6970
```bash
7071
python3 -m http.server 8000

app.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
const CSV_PATH = "conferences.csv";
1+
const CSV_PATH = "data/conferences.csv";
22
const STORAGE_KEY = "conference_dashboard_filters_v1";
33
const GEO_CACHE_KEY = "conference_dashboard_geo_cache_v3";
44
const UI_PREFS_KEY = "conference_dashboard_ui_prefs_v1";
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)