Skip to content

Commit 2d3e2ee

Browse files
committed
docs: align feed-directory contracts with registry sync
1 parent 407005c commit 2d3e2ee

1 file changed

Lines changed: 4 additions & 3 deletions

File tree

AGENTS.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ What this repo owns:
1414
What this repo does not own:
1515

1616
- runtime extractor behavior and CLI semantics (`html2rss/`)
17-
- catalog metadata, YAML configs, or catalog serialization (`html2rss-configs/``Html2rss::Configs::Catalog`)
18-
- catalog HTTP API (`html2rss-web/``GET /api/v1/configs`)
17+
- feed YAML and signed registry bundle publishing (`html2rss-configs/``configs/`, `tool/registry-build`)
18+
- catalog HTTP API and registry sync (`html2rss-web/``GET /api/v1/configs`, `Registry::Sync`)
1919

2020
When docs describe behavior from other repos, treat those repos as source-of-truth and update docs to match them.
2121

@@ -30,9 +30,10 @@ Before substantial edits, state cross-repo context in your notes:
3030
Common contracts:
3131

3232
- Feed Directory browse data comes from `{instance}/api/v1/configs` on a running `html2rss-web` instance (see OpenAPI in `html2rss-web`).
33+
- Catalog wire rows include `id`, `path`, `directory`, `channel`, `parameters`, plus `source` (`registry` | `local`) and `registry` (registry id for bundle entries). The browse UI ignores `source`/`registry` today — wire parsing stays in `adapters/catalog-api.ts`.
3334
- Instance URL persistence: default public instance, `#!url=` hash deep link from the web app, browser localStorage, and filter state in URL query params (`q`, `topic`, `lang`, `sort`, `page`).
3435
- Deep link from `html2rss-web`: `https://html2rss.github.io/feed-directory/#!url={encodedInstanceUrl}` must keep working.
35-
- Catalog metadata in YAML (`directory.title`, `directory.summary`, `directory.topics`) is authored in `html2rss-configs` only.
36+
- Catalog metadata in YAML (`directory.*`, `registry.id`) is authored in `html2rss-configs` only; instances load verified bundles via registry sync.
3637
- Ruby gem docs should match `html2rss` behavior and CLI output.
3738
- Web application docs should match `html2rss-web` behavior and published OpenAPI.
3839

0 commit comments

Comments
 (0)