-
-
Notifications
You must be signed in to change notification settings - Fork 1
Home
Teofanis Papadopulos edited this page Jun 14, 2026
·
2 revisions
How the repo fits together — data flow, deploys, and where to look when you change something.
Diagrams are Mermaid (render on GitHub Wiki and in the IDE).
| Page | Read this when… |
|---|---|
| Architecture-Monorepo | You're new to the repo or need the big picture |
| Architecture-Web | You touch the marketing site, caching, or live.json
|
| Architecture-Desktop | You work on the Wails app, queue, or downloads |
| Architecture-Desktop-Updates | You change in-app updates or release channels |
| Architecture-Extension-Deep-Links | You work on the extension or ybdownloader:// links |
| Architecture-Releases-and-CI | You cut a release or debug CI |
| Location | Purpose |
|---|---|
docs/wiki/ (this wiki) |
Architecture — update when behaviour or pipelines change |
apps/*/README.md |
Commands for that app (build, dev, deploy) |
| README.md | User-facing intro and getting started |
| CONTRIBUTING.md | PRs, branches, local setup |
Don't duplicate build commands here — they drift. Link to the app README instead.
| You changed… | Update… |
|---|---|
Web caching, live.json, deploy |
Architecture-Web + apps/web/README.md
|
| Desktop queue, downloader, Wails bindings | Architecture-Desktop |
| Updater or channel logic |
Architecture-Desktop-Updates + packages/shared/src/releases.ts
|
| Extension UI or deep link format |
Architecture-Extension-Deep-Links + packages/shared/src/deep-link.ts
|
| Workflows, tags, release process | Architecture-Releases-and-CI |
Merged to main → CI syncs docs/wiki/ to the GitHub Wiki automatically.