Skip to content

Commit e658477

Browse files
committed
docs: align Feed Directory metadata and terminology
Unify registry.id / directory.* requirements across MCP and contributor guides, and replace stale "included feeds" / lowercase "feed directory" wording with consistent Feed Directory terminology.
1 parent 5deb9f6 commit e658477

8 files changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The Codespace provides a cloud development environment with Node.js pre-installe
5050

5151
- **New to RSS?** → Start with the [web application](https://html2rss.github.io/web-application)
5252
- **Ruby Developer?** → Check out the [Ruby gem documentation](https://html2rss.github.io/ruby-gem)
53-
- **Need a specific feed?** → Browse the [feed directory](https://html2rss.github.io/feed-directory)
53+
- **Need a specific feed?** → Browse the [Feed Directory](https://html2rss.github.io/feed-directory)
5454
- **Want to contribute?** → See our [contributing guide](https://html2rss.github.io/get-involved/contributing)
5555

5656
## Contributing

src/content/docs/ruby-gem/guides/ai-agent-workflows.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ When an agent is tasked with creating a durable YAML feed configuration:
9494

9595
1. **Capture:** Call `capture_config`. YAML is `payload.yaml` (`items` + `enhance: true`). Check `payload.articles_count` and `has_selectors`.
9696
2. **Recon (optional):** Call `inspect_url` for `final_url`, `status`, `scheme_downgrade`, and `alternate_feeds` if the draft is weak.
97-
3. **Rewrite:** If the destination is html2rss-configs, declare `registry.id`, add `directory.topics`, and set explicit channel `title`/`url`. Strive to keep `enhance: true` (set `false` only when chrome leaks into items).
97+
3. **Rewrite:** If the destination is html2rss-configs, declare `registry.id`, `directory.topics` (non-empty), `directory.title`, and mirror `channel.title` (required for Feed Directory configs). Optional `directory.summary` (max 160 characters). Set explicit channel `url`. Strive to keep `enhance: true` (set `false` only when chrome leaks into items).
9898
4. **Validate:** Pass `yaml` (or `config`) to `validate_config`. Exactly one of those arguments.
9999
5. **Apply:** Call `apply_config`. `isError` plus `payload.item_count: 0` means the config is not shippable — channel title in the XML is not success.
100100

src/content/docs/ruby-gem/guides/capturing-feed-configs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ MCP `capture_config` returns that YAML in `payload.yaml`. `validate_config` / `a
100100
1. Validate: `html2rss validate my-feed.yml`
101101
2. Render: `html2rss feed my-feed.yml`
102102
3. Tighten the items selector, strategy, or `request.botasaurus` options if needed
103-
4. For Feed Directory contributions, add `directory.topics` and keep `enhance: true` unless chrome leaks (see [Creating Custom Feeds](/creating-custom-feeds/#sharing-your-config))
103+
4. For Feed Directory contributions, declare `registry.id`, `directory.topics` (non-empty), `directory.title`, and mirror `channel.title`; keep `enhance: true` unless chrome leaks (see [Creating Custom Feeds](/creating-custom-feeds/#sharing-your-config))
104104

105105
## Related
106106

src/content/docs/ruby-gem/reference/mcp-server.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@ Four-step workflow for a durable feed config:
165165
3. Call `validate_config` with `yaml` (or `config`) — must not be `isError`.
166166
4. Call `apply_config``isError` if zero items. Confirm `payload.item_count` before shipping.
167167

168-
If the destination is html2rss-configs, rewrite the draft with `registry.id`, `directory.topics`, and explicit channel `title`/`url`.
168+
If the destination is html2rss-configs, rewrite the draft with `registry.id`, `directory.topics` (non-empty), `directory.title`, and mirror `channel.title` (required for Feed Directory configs). Optional `directory.summary` (max 160 characters). Set explicit channel `url`.
169169

170170
- **Arguments:**
171171
- `url` _(string, required)_: Target URL to analyze.

src/content/docs/web-application/deployment.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The examples use `html2rss/web:1`, the recommended major-version tag. Pin an exa
1818
There are two materially different deployment modes:
1919

2020
- **Automatic generation enabled:** primary self-hosted workflow, requires `AUTO_SOURCE_ENABLED=true` and `HTML2RSS_ACCESS_TOKEN`
21-
- **Included feeds fallback only:** lower-maintenance path when the Feed Directory already covers your needs
21+
- **Feed Directory only:** lower-maintenance path when the Feed Directory already covers your needs
2222

2323
If you do not need page-URL generation yet, keep `AUTO_SOURCE_ENABLED` off and ship the fallback mode only.
2424

src/content/docs/web-application/getting-started.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ When output quality is poor, change the input URL first before assuming setup is
9595

9696
## Fallback Path
9797

98-
If the site you want is already in the feed directory, or you want a fast sample before creating another generated feed, use the feed directory on your own instance.
98+
If the site you want is already in the Feed Directory, or you want a fast sample before creating another generated feed, use the Feed Directory on your own instance.
9999

100100
- [Use the Feed Directory](/web-application/guides/use-the-feed-directory/)
101101
- [Feed Directory](/feed-directory/)

src/content/docs/web-application/guides/use-the-feed-directory.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: "Use the built-in Feed Directory from your own html2rss-web instanc
77

88
## How to Use Them
99

10-
1. **Find a feed** in the [Feed Directory](/feed-directory/) (loaded from the active instance catalog)
10+
1. **Find a feed** in the [Feed Directory](/feed-directory/) (loaded from your active `html2rss-web` instance)
1111
2. **Set the Instance URL** to your own `html2rss-web` address when it differs from the default
1212
3. **Open the feed path** from your instance (for example `/anthropic.com/news.rss`)
1313
4. **Add it to your feed reader**
@@ -33,8 +33,8 @@ Just replace `localhost:4000` with your own `html2rss-web` address.
3333

3434
Use a custom config when:
3535

36-
- the site you want is not in the directory
37-
- the directory feed misses fields you care about
36+
- the site you want is not in the Feed Directory
37+
- the Feed Directory feed misses fields you care about
3838
- you need a more specific page, section, or output format
3939

4040
Next steps:

src/content/docs/web-application/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Start with **[Getting Started](/web-application/getting-started/)** to:
2020

2121
- **Web interface:** direct feed creation from page URLs
2222
- **Access-controlled generation:** `POST /api/v1/feeds` expects the token configured on your instance
23-
- **Included Feed Directory:** packaged fallback feeds you can use immediately from your own deployment
23+
- **Feed Directory:** pre-built feeds synced from signed registry bundles on your own deployment
2424
- **Config-based extension path:** move to custom feeds when you need reviewable rules
2525
- **Caching and HTTP handling:** shipped as part of the deployment
2626
- **Generated API contract:** OpenAPI is published at `/openapi.yaml`

0 commit comments

Comments
 (0)