Skip to content

docs: separate the workspace-internal packages from the published ones #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hhkaos merged 2 commits into from
Nov 5, 2026
Merged

docs: separate the workspace-internal packages from the published ones #114

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ee024dc
docs: separate the workspace-internal packages from the published ones
hhkaos Nov 4, 2026
12c7fbd
docs: the spec badge still said v0.4
hhkaos Nov 4, 2026
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
23 changes: 18 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![CI](https://github.com/OpenTechEvents/ote-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/OpenTechEvents/ote-tools/actions/workflows/ci.yml)
[![Deploy tools site](https://github.com/OpenTechEvents/ote-tools/actions/workflows/deploy-tools.yml/badge.svg)](https://github.com/OpenTechEvents/ote-tools/actions/workflows/deploy-tools.yml)
![OTE spec](https://img.shields.io/badge/OTE%20spec-v0.4-2563eb)
![OTE spec](https://img.shields.io/badge/OTE%20spec-v0.6-2563eb)
![Node](https://img.shields.io/badge/node-%3E%3D22-339933)
![pnpm](https://img.shields.io/badge/pnpm-11.13.1-f69220)

Expand All @@ -24,14 +24,27 @@ Design rationale lives in [DESIGN.md](DESIGN.md); the spec lives in
| [`@opentechevents/import-ics`](packages/import-ics/) | iCalendar (`.ics`) → partial OTE event documents (review-and-complete). |
| [`@opentechevents/import-jsonld`](packages/import-jsonld/) | schema.org Event JSON-LD in an HTML page → partial OTE event documents. |
| [`@opentechevents/build-feed`](packages/build-feed/) | `events/*.json` + `ote.config.json` → validated `feed.json` + `feed.ics` + `feed.xml`. |
| [`@opentechevents/discover-feed`](packages/discover-feed/) | Reference implementation of feed discovery: response bytes + content-type + URL → candidate feed URLs. No network. |

All connectors are pure functions with a thin CLI on top. They never invent
data: a field absent in the input stays absent in the output.

Published packages follow the OTE spec minor they implement (`0.4.x` speaks
OTE spec v0.4). Each package also has its own changelog so fixes and
improvements can be traced package by package.
Most packages follow the OTE spec minor they implement (`0.6.x` speaks OTE
spec v0.6). `migrate` is the exception and is versioned on its own: it spans
versions rather than implementing one. Each package also has its own
changelog so fixes and improvements can be traced package by package.

### Workspace-internal packages

These are **not published to npm** (`"private": true`). They exist because
two apps in this repo needed the same logic and a second copy would have
drifted — not as libraries for outside use, so they carry no compatibility
promise and can change shape whenever their callers do.

| Package | What it does | Used by |
| --- | --- | --- |
| [`@opentechevents/discover-feed`](packages/discover-feed/) | Reference implementation of feed discovery: response bytes + content-type + URL → candidate feed URLs. No network. | `apps/validator`, `workers/validator` |
| [`@opentechevents/feed-urls`](packages/feed-urls/) | `?repo=owner/name` → the URLs a browser can actually fetch a fork's published files from, including the custom-domain cases. | `apps/publish`, `apps/preview`, `apps/editor` |
| [`@opentechevents/preview-feed`](packages/preview-feed/) | Normalizes the three export formats (JSON, ICS, RSS) into one `PreviewFeed`/`PreviewEvent` shape for display. | `apps/embed`, `apps/preview`, `apps/editor` |

## Apps

Expand Down
Loading