You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
chore: remove PokeAPI references from README, docs, app and CI
Strips the 'inspired by PokeAPI' attributions and PokeAPI-style mentions from the README, design docs (SPEC/DATA_PIPELINE/DEVELOPMENT), app/main.py description, scripts/dump.py and refresh-data.yml — generalising the wording while keeping the rationale intact.
Copy file name to clipboardExpand all lines: docs/DATA_PIPELINE.md
+4-5Lines changed: 4 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,10 +18,9 @@ daily) refresh is plenty. That makes a pre-generated static dataset ideal:
18
18
-**Fast**: edge-cached files, no cold starts.
19
19
20
20
### How others do it
21
-
-**PokeAPI** converted its API to **static JSON files** in 2018, generated
22
-
from its database by an updater bot and hosted on cheap static hosting +
23
-
Cloudflare CDN. See [PokeAPI/api-data](https://github.com/PokeAPI/api-data),
24
-
[pokeapi.co/about](https://pokeapi.co/about).
21
+
-**Static-API conversion**: several open APIs convert their database to a tree
22
+
of **static JSON files** generated by an updater bot and hosted on cheap static
23
+
hosting + a CDN — no server, trivial to scale and self-host.
25
24
-**Git scraping** (Simon Willison): a scheduled GitHub Actions job fetches
26
25
data, pretty-prints it, and commits it back when it changes — no server
27
26
needed. See [simonwillison.net](https://simonwillison.net/2020/Oct/9/git-scraping/).
@@ -80,7 +79,7 @@ real option but is a **strategy change**, so here are the paths:
80
79
81
80
| Option | What it means | Trade-offs |
82
81
|---|---|---|
83
-
|**A. Public (current SPEC)**|`data/` + static dump public, CC-BY-SA | Simplest; matches open-data mission & PokeAPI model; community can contribute & self-host. Anyone can copy the data. |
82
+
|**A. Public (current SPEC)**|`data/` + static dump public, CC-BY-SA | Simplest; matches the open-data mission; community can contribute & self-host. Anyone can copy the data. |
84
83
|**B. Private factory → public product**| Scrapers + raw/messy data in a **private** repo; only a curated, licensed **public dump** is published | Best of both: keep collection methods/raw data private, still ship an open API. Two repos to run. |
85
84
|**C. Fully private**| Data + dump + API all private (private repo, auth-gated API) | Maximum control / proprietary value, but abandons the open-data positioning, CC-BY-SA, and community contributions. The API stays code-MIT but data is closed. |
0 commit comments