Skip to content

Commit 37655ed

Browse files
committed
feat: update copy
1 parent 1c77011 commit 37655ed

6 files changed

Lines changed: 35 additions & 40 deletions

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
# html2rss.github.io
22

3-
🚧 WIP / Work in progress 🚧
3+
This repository hosts the documentation and website for `html2rss`, a tool for creating RSS feeds from any website.
4+
5+
## Contributing
6+
7+
Contributions are welcome! See our [Get Involved page](https://html2rss.github.io/get-involved) for details on discussions, reporting issues, and contributing.

get-involved/index.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,9 @@ nav_order: 4
77

88
# Get Involved
99

10-
Want to participate in the `html2rss` project? Explore the options below to engage with our community and contribute to the project's growth.
10+
Engage with the `html2rss` project. Contribute and connect with the community.
1111

12-
- [**The Project Roadmap**]({{ 'https://github.com/orgs/html2rss/projects/3/views/1' }}): See what's being worked on, planned, and needs attention across all `html2rss` components.
13-
- [**Report Bugs & Discuss Features**]({{ '/get-involved/issues-and-features' | relative_url }}): Found a bug or have a new feature idea? Learn where to report and discuss them.
14-
- [**Join Community Discussions**]({{ '/get-involved/discussions' | relative_url }}): Connect with other users and contributors, ask questions, and share ideas.
15-
- [**Contribute to html2rss**]({{ '/contributing' | relative_url }}): Ready to contribute code, documentation, or feed configurations? Find detailed guides here.
16-
17-
---
18-
19-
We appreciate your interest in `html2rss` and look forward to your involvement!
12+
- [**Project Roadmap**]({{ 'https://github.com/orgs/html2rss/projects/3/views/1' }}): View current work, plans, and priorities.
13+
- [**Report Bugs & Discuss Features**]({{ '/get-involved/issues-and-features' | relative_url }}): Report bugs or propose features.
14+
- [**Join Community Discussions**]({{ '/get-involved/discussions' | relative_url }}): Connect with users and contributors.
15+
- [**Contribute to html2rss**]({{ '/contributing' | relative_url }}): Contribute code, documentation, or feed configurations.

index.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,28 @@ nav_order: 1
66

77
# Create RSS Feeds for Any Website
88

9-
Tired of missing updates from websites that don't offer RSS feeds? `html2rss` is a powerful and flexible tool that lets you create your own RSS feeds for almost any website.
10-
11-
[**🚀 Get Started with the Web App!**]({{ '/web-application/getting-started' | relative_url }})
9+
`html2rss` creates RSS feeds for any website.
10+
[**🚀 Get Started with the Web App**]({{ '/web-application/getting-started' | relative_url }})
1211

1312
---
1413

1514
## Key Features
1615

17-
- **Automatic Feed Generation:** The `auto-source` scraper intelligently finds and extracts content from websites, so you can create feeds with minimal effort.
18-
- **Precise Content Extraction:** Use familiar CSS selectors to target the exact content you want to include in your feed.
19-
- **JavaScript Rendering:** Use a headless browser to render JavaScript-heavy websites and extract content that isn't available in the initial HTML.
20-
- **Open Source:** `html2rss` is free to use, modify, and contribute to.
16+
- **Automatic Feed Generation:** `auto_source` intelligently extracts content, simplifying feed creation.
17+
- **Precise Content Extraction:** Use CSS selectors for targeted content inclusion.
18+
- **JavaScript Rendering:** A headless browser renders JavaScript-heavy sites for comprehensive content extraction.
19+
- **Open Source:** `html2rss` is free to use, modify, and contribute.
2120

2221
---
2322

2423
## The html2rss Ecosystem
2524

26-
The `html2rss` project is more than just a single tool. It's a collection of tools that work together to provide a complete RSS solution:
25+
The `html2rss` project offers a complete RSS solution through a collection of integrated tools:
2726

28-
- **[html2rss-web]({{ '/web-application' | relative_url }}):** A user-friendly web application that makes it easy to create, manage, and share RSS feeds. This is the recommended starting point for most users.
29-
- **[html2rss (Ruby Gem)]({{ '/ruby-gem' | relative_url }}):** The core library that powers the web application. It provides a powerful and flexible command-line interface for creating custom RSS feeds.
30-
- **[Feed Directory]({{ '/feed-directory' | relative_url }}):** A public listing of RSS feeds for websites of interest, powered by community-driven configurations.
27+
- **[html2rss-web]({{ '/web-application' | relative_url }}):** User-friendly web application to create, manage, and share RSS feeds. Recommended starting point.
28+
- **[html2rss (Ruby Gem)]({{ '/ruby-gem' | relative_url }}):** Core library and command-line interface for developers.
29+
- **[Feed Directory]({{ '/feed-directory' | relative_url }}):** Public listing of community-driven RSS feed configurations.
3130

3231
---
3332

34-
Want to engage with the `html2rss` community or contribute to the project? Visit our [Get Involved]({{ '/get-involved' | relative_url }}) page for details on discussions, reporting issues, and contributing.
33+
Engage with the `html2rss` community or contribute. Visit our [Get Involved]({{ '/get-involved' | relative_url }}) page.

ruby-gem/index.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,11 @@ has_children: true
77

88
# The html2rss Ruby Gem ([GitHub Repo](https://github.com/html2rss/html2rss))
99

10-
This section provides detailed documentation for the `html2rss` Ruby gem. The gem is the core library that powers the `html2rss-web` application.
11-
12-
If you are looking for the easiest way to get started with `html2rss`, we recommend using the [web application]({{ '/web-application' | relative_url }}).
13-
14-
This documentation is for developers who want to use the `html2rss` gem directly.
10+
This section documents the `html2rss` Ruby gem, the core library for `html2rss-web`. This documentation targets developers using the gem directly. For an easier start, use the [web application]({{ '/web-application' | relative_url }}).
1511

1612
## Getting Started
1713

18-
We recommend starting with the [Installation guide]({{ '/ruby-gem/tutorials/installation' | relative_url }}) to set up `html2rss` on your system. Once installed, proceed to our step-by-step guide to [creating your first feed]({{ '/ruby-gem/tutorials/your-first-feed' | relative_url }}).
14+
Start with the [Installation guide]({{ '/ruby-gem/tutorials/installation' | relative_url }}). Then, create your [first feed]({{ '/ruby-gem/tutorials/your-first-feed' | relative_url }}).
1915

2016
## Documentation Sections
2117

@@ -25,9 +21,9 @@ We recommend starting with the [Installation guide]({{ '/ruby-gem/tutorials/inst
2521

2622
## Advanced Topics
2723

28-
- [**Handling Dynamic Content and JavaScript**]({{ '/ruby-gem/how-to/handling-dynamic-content' | relative_url }}): Learn how to handle JavaScript-heavy websites.
29-
- [**Customizing HTTP Requests**]({{ '/ruby-gem/how-to/custom-http-requests' | relative_url }}): How to send custom HTTP headers.
24+
- [**Handling Dynamic Content and JavaScript**]({{ '/ruby-gem/how-to/handling-dynamic-content' | relative_url }}): Process JavaScript-heavy websites.
25+
- [**Customizing HTTP Requests**]({{ '/ruby-gem/how-to/custom-http-requests' | relative_url }}): Send custom HTTP headers.
3026
- [**Dynamic Parameters in URLs and Headers**]({{ '/ruby-gem/how-to/dynamic-parameters' | relative_url }}): Use dynamic parameters in URLs and headers.
31-
- [**Advanced Content Extraction with Selectors**]({{ '/ruby-gem/how-to/advanced-content-extraction' | relative_url }}): Precise content extraction techniques.
32-
- [**Styling Your RSS Feed**]({{ '/ruby-gem/how-to/styling-rss-feed' | relative_url }}): Add stylesheets to your RSS feed.
33-
- [**Debugging Your Configuration**]({{ '/support/troubleshooting' | relative_url }}): Debug your feed configuration effectively.
27+
- [**Advanced Content Extraction with Selectors**]({{ '/ruby-gem/how-to/advanced-content-extraction' | relative_url }}): Advanced content extraction.
28+
- [**Styling Your RSS Feed**]({{ '/ruby-gem/how-to/styling-rss-feed' | relative_url }}): Add stylesheets to RSS feeds.
29+
- [**Debugging Your Configuration**]({{ '/support/troubleshooting' | relative_url }}): Debug feed configurations.

web-application/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,17 @@ has_children: true
77

88
# html2rss-web
99

10-
This web application scrapes websites to build and deliver RSS 2.0 feeds. It's a powerful tool for creating custom RSS feeds for any website.
10+
This web application scrapes websites to build and deliver RSS 2.0 feeds. It is a powerful tool for creating custom RSS feeds.
1111

1212
## Get Started
1313

14-
Ready to dive in? Our **[Getting Started guide]({{ '/web-application/getting-started' | relative_url }})** will walk you through the essential first steps, from understanding the application to installing your own instance.
14+
Our **[Getting Started guide]({{ '/web-application/getting-started' | relative_url }})** covers essential first steps, from understanding the application to installing your own instance.
1515

1616
## Key Features
1717

18-
- **Stable URLs:** Provides stable URLs for feeds generated by automatic sourcing.
19-
- **Custom Feeds:** Create your own custom feeds.
20-
- **Feed Directory:** Comes with plenty of [feeds](https://github.com/html2rss/html2rss-configs) out of the box.
21-
- **Caching:** Handles request caching and sets caching-related HTTP headers.
18+
- **Stable URLs:** Provides stable URLs for automatically sourced feeds.
19+
- **Custom Feeds:** Create custom feeds.
20+
- **Feed Directory:** Includes many [feeds](https://github.com/html2rss/html2rss-configs) out of the box.
21+
- **Caching:** Handles request caching and sets HTTP headers.
2222

2323
The functionality of scraping websites and building the RSS feeds is provided by the Ruby gem [`html2rss`](https://github.com/html2rss/html2rss).

web-application/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,5 @@ Congratulations! Your personal `html2rss-web` instance is now running. You can a
9090

9191
## Next Steps
9292

93-
- Now that your instance is running, head over to the **[Tutorials]({{ '/web-application/tutorials' | relative_url }})** to learn how to create your first feed.
93+
- Now that your instance is running, head over to the **[How-To Guides]({{ '/web-application/how-to/' | relative_url }})** to learn how to create your first feed. We recommend starting with the [Creating Custom Feeds]({{ '/web-application/how-to/creating-custom-feeds' | relative_url }}) guide.
9494
- For a more secure setup, consider putting your instance behind a reverse proxy. You can find more information in the [deployment guide]({{ '/web-application/how-to/deployment' | relative_url }}).

0 commit comments

Comments
 (0)