Skip to content

Commit 52ec0cc

Browse files
committed
docs(onboarding): make web app guide canonical
1 parent dffae70 commit 52ec0cc

2 files changed

Lines changed: 30 additions & 117 deletions

File tree

src/content/docs/getting-started.mdx

Lines changed: 12 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -5,120 +5,21 @@ sidebar:
55
order: 1
66
---
77

8-
import AutoGenerationOptional from "../../components/docs/AutoGenerationOptional.astro";
9-
import MinimalDockerCompose from "../../components/docs/MinimalDockerCompose.astro";
8+
This page points to the main onboarding flow.
109

11-
Ready to get RSS feeds from any website? Run `html2rss-web` locally with Docker, verify the interface, then start with included feeds before you move on to custom configs.
10+
## Start Here
1211

13-
## What Success Looks Like
12+
If you want the recommended path, go to [Run html2rss-web with Docker](/web-application/getting-started).
1413

15-
After this guide, you should have:
14+
That guide is the canonical setup flow for:
1615

17-
- `html2rss-web` running at `http://localhost:3000`
18-
- a list of working included feeds
19-
- a clear next step for either auto-generation or custom configs
16+
- running `html2rss-web` locally
17+
- confirming your first successful feed
18+
- deciding when to use included feeds, automatic generation, or custom configs
2019

21-
## Recommended Path
20+
## Quick Shortcuts
2221

23-
This guide will help you set up your own copy of `html2rss-web` on your computer. Start here if you want the most reliable path and the newest integrated behavior.
24-
25-
### What You'll Need
26-
27-
- **Docker** - A tool that makes installation simple (like an app store for server software)
28-
- **About 10 minutes** - The whole process is quick and automated
29-
30-
**Don't have Docker?** [Install it first](https://docs.docker.com/get-started/) - it's free and works on all major operating systems.
31-
32-
### Step 1: Create a Folder
33-
34-
Create a new folder on your computer to store html2rss-web files:
35-
36-
**Create a new folder** on your computer and name it "html2rss-web". You can do this through your file manager or terminal:
37-
38-
```bash
39-
mkdir html2rss-web
40-
cd html2rss-web
41-
```
42-
43-
### Step 2: Create a Minimal Configuration File
44-
45-
Create a file called `docker-compose.yml` in your new folder. Start with the minimal local stack:
46-
47-
<MinimalDockerCompose />
48-
49-
Add update automation such as Watchtower later, after the first run works.
50-
51-
### Step 3: Download the Feed List
52-
53-
html2rss-web needs a list of feeds to work with. Download our pre-made list:
54-
55-
**Download the feeds.yml file:**
56-
57-
- **Using your browser:** Right-click [this link](https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml) → Save As → Name it "feeds.yml" → Save in your html2rss-web folder
58-
- **Using terminal:** Open Terminal in your html2rss-web folder and run:
59-
60-
```bash
61-
curl https://raw.githubusercontent.com/html2rss/html2rss-web/master/config/feeds.yml -o feeds.yml
62-
```
63-
64-
### Step 4: Start html2rss-web
65-
66-
Open a terminal in your html2rss-web folder and run:
67-
68-
```bash
69-
docker compose up -d
70-
```
71-
72-
## First Success Check
73-
74-
At this point, `html2rss-web` should be running.
75-
76-
1. Open your web browser
77-
2. Go to `http://localhost:3000`
78-
3. You should see the html2rss-web interface with a list of available feeds
79-
80-
If you see the interface, the install worked.
81-
82-
---
83-
84-
## What To Do First
85-
86-
### Browse Existing Feeds
87-
88-
Your instance comes with pre-configured feeds for many websites. Browse the list, open one feed, and copy its RSS URL into your feed reader.
89-
90-
This is the easiest way to confirm the whole stack is healthy.
91-
92-
### Then Choose Your Next Step
93-
94-
- **Included feed works:** keep using the built-in configs and browse the [Feed Directory](/feed-directory/)
95-
- **Need a feed for a new site:** decide between auto-generation and a custom config
96-
- **Need stable, repeatable control:** move to [Creating Custom Feeds](/creating-custom-feeds)
97-
98-
<AutoGenerationOptional />
99-
100-
## When To Use Each Option
101-
102-
- **Use included configs** when the site already exists in the directory
103-
- **Enable automatic feed generation** when you want to try a site quickly without writing YAML
104-
- **Write a custom config** when auto-generation is incomplete or you need precise control
105-
106-
---
107-
108-
## Troubleshooting
109-
110-
**Common issues when getting started:**
111-
112-
- **Instance won't start?** Check that Docker is running and the port isn't already in use
113-
- **Can't access the interface?** Make sure you're going to `http://localhost:3000`
114-
- **Auto-sourced feed not working?** Some websites need custom configuration - see our [troubleshooting guide](/troubleshooting/troubleshooting)
115-
- **Need help?** Join our [community discussions](https://github.com/orgs/html2rss/discussions)
116-
117-
---
118-
119-
## Next Steps
120-
121-
1. **[Use the included configs](/web-application/how-to/use-included-configs/)** - Start with working feeds
122-
2. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)** - Enable the quick-generate flow
123-
3. **[Create Custom Feeds](/creating-custom-feeds)** - Add and test your own YAML configs
124-
4. **[Troubleshooting Guide](/troubleshooting/troubleshooting)** - Solve startup and extraction issues
22+
- **[Run html2rss-web with Docker](/web-application/getting-started)** - Recommended first step
23+
- **[Browse working feed examples](/feed-directory/)** - See what success looks like
24+
- **[Create Custom Feeds](/creating-custom-feeds)** - Write configs when you need more control
25+
- **[Troubleshooting Guide](/troubleshooting/troubleshooting)** - Fix startup or extraction problems

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

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,29 @@ sidebar:
66
order: 1
77
---
88

9-
This web application scrapes websites to build and deliver RSS 2.0 feeds. It is a powerful tool for creating custom RSS feeds.
9+
`html2rss-web` is the recommended way to get started. Run it locally with Docker, use included feeds first, and move to automatic generation or custom configs only when you need more control.
1010

1111
## Get Started
1212

13-
Our **[Getting Started guide](/web-application/getting-started)** covers essential first steps, from understanding the application to installing your own instance.
13+
Start with **[Getting Started](/web-application/getting-started)** to:
14+
15+
- run your own local instance
16+
- confirm a first successful feed
17+
- choose the right next step for your site
1418

1519
## Key Features
1620

17-
- **Stable URLs:** Provides stable URLs for automatically sourced feeds.
18-
- **Custom Feeds:** Create custom feeds.
19-
- **Feed Directory:** Includes many [feeds](https://github.com/html2rss/html2rss-configs) out of the box.
20-
- **Caching:** Handles request caching and sets HTTP headers.
21+
- **Stable URLs:** Provides stable URLs for feeds served from your own instance
22+
- **Included Feeds:** Start with many working configs out of the box
23+
- **Automatic Generation:** Try new sites quickly when the feature is enabled
24+
- **Custom Feeds:** Create and refine your own configs when you need more control
25+
- **Caching:** Handles request caching and sets HTTP headers
2126

2227
The functionality of scraping websites and building the RSS feeds is provided by the Ruby gem [`html2rss`](https://github.com/html2rss/html2rss).
28+
29+
## Recommended Flow
30+
31+
1. **[Getting Started](/web-application/getting-started)** - Run the app locally
32+
2. **[Use the included configs](/web-application/how-to/use-included-configs/)** - Confirm a working feed first
33+
3. **[Use automatic feed generation](/web-application/how-to/use-automatic-feed-generation/)** - Try unsupported sites quickly
34+
4. **[Create Custom Feeds](/creating-custom-feeds)** - Build a stable custom setup when needed

0 commit comments

Comments
 (0)