richie/Provider-Crawl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add ONBOARDING.md for handoff context

Browse Source
This commit is contained in:
Richie
2026-04-24 10:29:40 +10:00
parent cc91427789
commit 56dde9cd88
2 changed files with 132 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -13,14 +13,16 @@ n8n/ n8n workflows that orchestrate the crawlers on a schedule
database/ SQLite + Postgres schemas, a seed dump, and a pre-populated dev DB
```
Three documents explain how it works, in increasing depth:
Four documents explain how it works, in increasing depth:
1. **[n8n/PROCESS.md](n8n/PROCESS.md)** — Plain-English end-to-end walkthrough
1. **[ONBOARDING.md](ONBOARDING.md)** — Human context: what the project is
for, ground rules, open work, how to get unblocked. **Start here if you're
new to the project.**
2. **[n8n/PROCESS.md](n8n/PROCESS.md)** — Plain-English end-to-end walkthrough
of the four workflows and how their output maps to database tables.
**Start here.**
2. **[crawlers/PIPELINE.md](crawlers/PIPELINE.md)** — Architecture of the
3. **[crawlers/PIPELINE.md](crawlers/PIPELINE.md)** — Architecture of the
Python modules, source-by-source notes, listing-tier logic.
3. **[n8n/README.md](n8n/README.md)** — How to stand up n8n locally with
4. **[n8n/README.md](n8n/README.md)** — How to stand up n8n locally with
Docker and import the workflow JSONs.
## Quick start (local, no n8n)