Skip to content

Commit 176a089

Browse files
committed
docs: reduce feed directory repetition
1 parent 4efb305 commit 176a089

6 files changed

Lines changed: 37 additions & 83 deletions

File tree

Lines changed: 16 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,47 @@
11
---
22
title: "Common Use Cases"
3-
description: "See how people use html2rss to stay updated with their favorite websites. Real examples for personal and business use cases."
3+
description: "Use html2rss for common tracking and monitoring workflows."
44
---
55

6-
Discover how people are using html2rss to take control of their web content consumption. These real-world examples show the power and flexibility of creating custom RSS feeds.
7-
8-
---
6+
Use html2rss when you want updates in a reader instead of checking websites by hand.
97

108
## Personal Use Cases
119

1210
### Following Your Favorite Bloggers
1311

14-
Many bloggers don't offer RSS feeds, but you can create them with html2rss. Follow writers you love without relying on social media algorithms.
12+
Many blogs and creator sites do not publish feeds.
1513

16-
**Example:** Create a feed for a personal blog that only posts to social media.
14+
**Example:** Follow a newsroom, company blog, or publication section from your own `html2rss-web` deployment.
1715

1816
### Job Hunting
1917

2018
Track job postings from multiple company websites in one place. Never miss an opportunity again.
2119

22-
**Example:** Follow job boards, company career pages, and industry-specific job sites.
20+
**Example:** Track a company careers page or a narrower role-specific listing.
2321

2422
### Local News
2523

2624
Follow your local newspaper or community website to stay informed about your neighborhood.
2725

28-
**Example:** Create feeds for local news sites, community forums, and city government updates.
26+
**Example:** Subscribe to local news sites, community forums, and city government updates from one reader.
2927

3028
### Academic Research
3129

3230
Follow new papers and research in your field from multiple sources.
3331

34-
**Example:** Track arXiv submissions, journal publications, and conference proceedings.
32+
**Example:** Track publication pages, research blogs, and conference updates.
3533

3634
### Product Updates
3735

3836
Get notified when software you use releases updates, new features, or security patches.
3937

40-
**Example:** Follow product blogs, changelog pages, and release notes.
38+
**Example:** Track release notes, changelog pages, and product blogs.
4139

4240
### Hobby Communities
4341

4442
Follow forums, communities, and websites related to your hobbies and interests.
4543

46-
**Example:** Track gaming forums, photography communities, or cooking blogs.
47-
48-
---
44+
**Example:** Track gaming forums, photography communities, or cooking blogs without manually checking each site.
4945

5046
## Business Use Cases
5147

@@ -59,21 +55,19 @@ Track what your competitors are posting about - new products, features, or annou
5955

6056
Follow multiple industry publications in one feed to stay ahead of trends.
6157

62-
**Example:** Aggregate news from industry blogs, trade publications, and thought leaders.
58+
**Example:** Aggregate trade publications, company blogs, and research updates in one reader.
6359

6460
### Customer Support
6561

6662
Monitor customer feedback and support requests across different platforms.
6763

68-
**Example:** Track support forums, review sites, and social media mentions.
64+
**Example:** Track support forums, review sites, and product-update pages that affect your users.
6965

7066
### Content Marketing
7167

7268
Follow industry influencers and competitors for content inspiration.
7369

74-
**Example:** Track competitor blogs, industry newsletters, and thought leadership content.
75-
76-
---
70+
**Example:** Track competitor blogs, industry newsletters, and thought leadership content in one place.
7771

7872
## Technical Use Cases
7973

@@ -95,20 +89,8 @@ Follow multiple open source projects and their updates.
9589

9690
**Example:** Track project blogs, release notes, and community discussions.
9791

98-
---
99-
100-
## Getting Started with Your Use Case
101-
102-
1. **Identify the websites** you want to follow
103-
2. **Check our [Feed Directory](/feed-directory/)** to see if feeds already exist
104-
3. **Try the [Web App](/web-application/getting-started)** to create feeds easily
105-
4. **Learn advanced techniques** with our [Config Guide](/creating-custom-feeds/)
106-
107-
---
108-
109-
## Need Help?
92+
## Next Steps
11093

111-
- **Can't find what you're looking for?** [Browse our Feed Directory](/feed-directory/)
112-
- **Want to create custom feeds?** [Try the Web App](/web-application/getting-started)
113-
- **Need advanced features?** [Check our Ruby Gem docs](/ruby-gem/)
114-
- **Have questions?** [Join our community discussions](https://github.com/orgs/html2rss/discussions)
94+
- **[Run html2rss-web with Docker](/web-application/getting-started)** to verify your own instance.
95+
- **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)** when you want direct page-URL conversion.
96+
- **[Create custom feeds](/creating-custom-feeds/)** when you need stable, reviewable extraction rules.

src/content/docs/creating-custom-feeds.mdx

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,13 @@ sidebar:
77

88
import { Aside, Code } from "@astrojs/starlight/components";
99

10-
When auto-sourcing isn't enough, you can write your own configuration files to create custom RSS feeds for any website. This guide shows you how to take full control with YAML configs.
10+
When existing feeds or auto-sourcing are not enough, write a YAML config for the site you want to follow.
1111

1212
**Prerequisites:** You should be familiar with the [Getting Started](/getting-started) guide before diving into custom configurations.
1313

1414
<Aside type="tip" title="Use this guide when you need more control">
15-
Start with included feeds first. If your site is not covered, try [automatic feed
16-
generation](/web-application/how-to/use-automatic-feed-generation/) next. Reach for a custom config when you
17-
need a stable, reviewable setup or the generated feed misses important content.
15+
Reach for a custom config when you need stable, reviewable extraction rules or generated output misses
16+
important content.
1817
</Aside>
1918

2019
---
@@ -29,10 +28,6 @@ When auto-sourcing isn't enough, you can write your own configuration files to c
2928
- **The website has complex structure** that requires custom selectors
3029
- **You want to combine data** from multiple sources
3130

32-
**Don't need custom configs?** Check the [Feed Directory](/feed-directory/) first - there might already be a working feed for your website.
33-
34-
---
35-
3631
## Recommended Workflow
3732

3833
1. **Inspect the live page** in your browser developer tools
@@ -217,7 +212,6 @@ there.
217212

218213
**For Beginners:**
219214

220-
- **[Browse the Feed Directory](/feed-directory/)** - See real-world examples
221215
- **[Run html2rss-web with Docker](/web-application/getting-started)** - Use the newest integrated behavior
222216
- **[Learn more about selectors](/ruby-gem/reference/selectors/)** - Master CSS selectors
223217
- **[Submit your config via GitHub Web](https://github.com/html2rss/html2rss-configs)** - No Git knowledge required!

src/content/docs/getting-started.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: "Getting Started"
3-
description: "Start html2rss-web locally, verify a working included feed from your self-hosted instance, and decide when to enable automatic generation or move to custom configs."
3+
description: "Start html2rss-web locally, verify one feed, and decide when to enable automatic generation or move to custom configs."
44
sidebar:
55
order: 1
66
---
@@ -17,13 +17,12 @@ That guide is the canonical setup flow for:
1717

1818
- running `html2rss-web` locally
1919
- confirming the interface is working
20-
- opening a first included feed URL
20+
- opening a known feed URL
2121
- deciding when to use automatic generation or custom configs
2222

2323
## Quick Shortcuts
2424

2525
- **[Run html2rss-web with Docker](/web-application/getting-started)**: recommended first step
26-
- **[Browse working feed examples](/feed-directory/)**: see what successful outputs look like
2726
- **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct feed creation from a page URL when you want that workflow
2827
- **[Create Custom Feeds](/creating-custom-feeds)**: write configs when you need more control
2928
- **[Troubleshooting Guide](/troubleshooting/troubleshooting)**: fix startup or extraction problems

src/content/docs/index.mdx

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: "Turn Any Website Into an RSS Feed"
3-
description: "Run html2rss-web with Docker, verify a working included feed from your self-hosted instance, then consciously enable automatic generation or move to custom configs when you need more control."
3+
description: "Run html2rss-web with Docker, verify one feed, then enable automatic generation or move to custom configs when you need more control."
44
---
55

6-
Run `html2rss-web` with Docker, verify a working included feed from your self-hosted instance, and only then decide whether to enable automatic generation or move to custom configs.
6+
Run `html2rss-web` with Docker, verify one feed from your own instance, then decide whether you need automatic generation or custom configs.
77

88
## Start Here
99

@@ -13,14 +13,8 @@ That guide is the canonical onboarding flow for:
1313

1414
- starting a local instance
1515
- verifying the web interface
16-
- opening a first included feed URL
17-
- deciding when to consciously enable automatic generation or move to custom configs
18-
19-
## How It Works
20-
21-
1. **Run your own local instance** with Docker
22-
2. **Open a built-in feed URL** from your own instance
23-
3. **Copy the feed URL into your reader**
16+
- opening a known feed URL
17+
- choosing the next path
2418

2519
## What is html2rss?
2620

@@ -36,8 +30,7 @@ Most people should start with the web application:
3630
### I want a working instance first
3731

3832
1. **[Run html2rss-web with Docker](/web-application/getting-started)**: recommended starting path
39-
2. **[Use the included configs](/web-application/how-to/use-included-configs/)**: use real embedded feeds from your own instance
40-
3. **[Browse working feed examples](/feed-directory/)**: see what working outputs look like
33+
2. **[Use the included configs](/web-application/how-to/use-included-configs/)**: optional guide for the embedded feed set
4134

4235
### I need more control
4336

@@ -62,7 +55,7 @@ Most people should start with the web application:
6255
## Practical Notes
6356

6457
- Start with Docker, not a public instance.
65-
- Use an included feed to verify the deployment first.
58+
- Verify the deployment with one known feed first.
6659
- Enable automatic generation only when you want the direct page-URL workflow and are ready to allow it on your self-hosted instance.
6760
- Move to custom configs when you need a stable, reviewable setup.
6861

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

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import { Code } from "@astrojs/starlight/components";
1010
import AutoGenerationOptional from "../../../components/docs/AutoGenerationOptional.astro";
1111
import MinimalDockerCompose from "../../../components/docs/MinimalDockerCompose.astro";
1212

13-
Run `html2rss-web` locally with Docker, open the web interface, and verify that your instance can serve a working included feed before you enable direct feed generation.
13+
Run `html2rss-web` locally with Docker and verify one included feed before enabling direct feed generation.
1414

1515
## What You Will Have When This Works
1616

@@ -23,7 +23,7 @@ After this guide, you should have:
2323

2424
## Installation Guide
2525

26-
This guide walks you through a local Docker setup that gives you the most reliable starting point.
26+
This guide uses a local Docker Compose stack.
2727

2828
### What You'll Need
2929

@@ -50,7 +50,7 @@ Create a file called `docker-compose.yml` in that folder and start with the mini
5050

5151
<MinimalDockerCompose />
5252

53-
This minimal stack intentionally proves the included-feed path first. Add automatic updates, reverse proxying, or your own config file only after this first run works.
53+
Add automatic updates, reverse proxying, or your own config file after this first run works.
5454

5555
### Step 3: Start html2rss-web
5656

@@ -73,28 +73,16 @@ Then run:
7373

7474
## First Success Check
7575

76-
At this point, `html2rss-web` should be running.
77-
7876
1. Open `http://localhost:4000`
7977
2. Confirm the web interface loads
8078
3. Open one of the included feed URLs from your own instance:
8179
- `http://localhost:4000/microsoft.com/azure-products.rss`
8280
- `http://localhost:4000/phys.org/weekly.rss`
8381
- `http://localhost:4000/softwareleadweekly.com/issues.rss`
8482
4. Confirm the feed opens
85-
5. Copy that feed URL into your reader
86-
87-
If that works, the deployment, included-config path, and reader subscription path are working together.
88-
89-
## What To Do First
90-
91-
Start with an included config from your own instance:
92-
93-
1. open a known included feed URL
94-
2. copy that feed URL into your reader
95-
3. confirm your reader can subscribe successfully
83+
5. Copy that feed URL into your reader if you want to keep it
9684

97-
That proves the lowest-friction path before you invest in automatic generation or custom configs.
85+
If that works, the local app and included-feed path are ready.
9886

9987
## What Changes If You Enable Feed Generation
10088

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

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,19 @@
11
---
22
title: "Web Application"
3-
description: "html2rss-web is the self-hosted web interface and feed server for running included feeds first, then enabling direct generation only when needed."
3+
description: "html2rss-web is the self-hosted web interface and feed server for included feeds, direct generation, and custom configs."
44
sidebar:
55
label: "Overview"
66
order: 1
77
---
88

9-
`html2rss-web` is the recommended way to get started. Run it locally with Docker, verify a working included feed from your own instance, and only then decide whether you need token-gated direct generation or custom configs.
9+
`html2rss-web` is the recommended way to get started. Run it locally with Docker, verify one feed from your own instance, then decide whether you need token-gated direct generation or custom configs.
1010

1111
## Get Started
1212

1313
Start with **[Getting Started](/web-application/getting-started)** to:
1414

1515
- run your own local instance
1616
- verify the web interface
17-
- open a first included feed URL
1817
- choose the right next step for your site
1918

2019
## What The Web App Gives You
@@ -31,10 +30,9 @@ The scraping and feed-building engine is provided by the Ruby gem [`html2rss`](h
3130
## Recommended Flow
3231

3332
1. **[Getting Started](/web-application/getting-started)**: run the app locally
34-
2. **[Use the included configs](/web-application/how-to/use-included-configs/)**: start with embedded feed paths from your own instance
35-
3. **[Browse working feed examples](/feed-directory/)**: compare against existing outputs
36-
4. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct page-URL conversion when you want that workflow
37-
5. **[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed
33+
2. **[Use the included configs](/web-application/how-to/use-included-configs/)**: use the embedded feed set when it covers your site
34+
3. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)**: enable direct page-URL conversion when you want that workflow
35+
4. **[Create Custom Feeds](/creating-custom-feeds)**: build a stable custom setup when needed
3836

3937
## For Integrations
4038

0 commit comments

Comments
 (0)