Skip to content

docs: align feed-directory and AGENTS with registry sync catalog - #1245

Draft
gildesmarais wants to merge 7 commits into
mainfrom
docs/feed-directory-registry-sync
Draft

gildesmarais wants to merge 7 commits into
mainfrom
docs/feed-directory-registry-sync

Conversation

@gildesmarais

@gildesmarais gildesmarais commented Aug 22, 2026 •

Copy link
Copy Markdown
Member

Stack (registry v1)

Land in order:

  1. html2rss — feat(registry): registry.v1 verify, domain-only catalog, and Ruby >= 4.0 html2rss#476
  2. html2rss-configs — refactor(registry)!: flat configs repo, signed registry.v1 bundles html2rss-configs#317
  3. html2rss-web — feat(registry): index sync with Index-edge wire map and gem pin html2rss-web#1097
  4. html2rss.github.io — docs: align feed-directory and AGENTS with registry sync catalog #1245 ← this PR

What changed

  • AGENTS.md — ownership: html2rss-configs → configs/ + tool/registry-build (#317); html2rss-web → GET /api/v1/configs + Registry::Sync (#1097)
  • Catalog wire contract — rows include id, path, directory, channel, parameters, source; bundle rows add registry; local rows omit registry; browse UI ignores source/registry (parsing in adapters/catalog-api.ts)
  • src/content/docs/web-application/reference/monitoring.mdx — Prettier table alignment only (no monitoring semantics change)

Why

Feed-directory browse UI loads catalog from a running instance’s registry sync (#1097), backed by signed bundles from #317 and verify logic in #476. Contributor docs still described the old gem/catalog model.

Risk

  • Low — documentation-only; no runtime or build behavior change
  • User-facing contributor pages still link to legacy lib/html2rss/configs paths (follow-up PR)

Review map

Review map: whole PR is small — start at AGENTS.md cross-repo contracts section.

Validation

  • make check — lint + build pass on CI
  • Wire shape cross-checked against #1097 request specs and OpenAPI

Replace legacy lib/html2rss/configs links with configs/, document
registry.id in contribution workflows, and use directory feed terminology.
Align feed-config contribution steps with creating-custom-feeds for Feed Directory catalog metadata.
Unify registry.id / directory.* requirements across MCP and contributor
guides, and replace stale "included feeds" / lowercase "feed directory"
wording with consistent Feed Directory terminology.
gildesmarais added a commit that referenced this pull request Nov 13, 2026
…#1295)

* docs(agents): describe the live catalog pipeline, not registry drafts

AGENTS.md described the registry work (signed bundles, tool/registry-build,
Registry::Sync, registry.id, source: registry|local). That work is still a
draft on PR #1245 and is not on main, so it misled agents about the current
contract.

Describe what ships today: YAML under html2rss-configs/lib/html2rss/configs/,
Html2rss::Configs::Catalog entries, html2rss-web serving GET /api/v1/configs
through the html2rss-configs gem, and source: embedded. The registry draft
PR carries its own AGENTS.md change.

Co-Authored-By: Claude Haiku 5.5 <noreply@anthropic.com>

* docs(agents): include last_result in served catalog row shape

The served row bullet omitted the required last_result that the v2 contract bullet already requires; point it at Catalog::Entry#to_h as owner.

Co-Authored-By: Claude Haiku 5.5 <noreply@anthropic.com>

---------

Co-authored-by: Claude Haiku 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant