refactor: reorganize documentation structure and update permalinks

Author: gildesmarais

about.md

@@ -1,39 +1,29 @@
 ---
 layout: default
 title: About html2rss
-# nav_order: 2
+nav_order: 2
 ---
 
 # About html2rss
 
-`html2rss` is an open-source project dedicated to empowering users to take control of their web content consumption. In an age where many websites no longer offer traditional RSS feeds, `html2rss` bridges this gap by providing a robust and flexible solution for converting any HTML content into a structured RSS format.
+`html2rss` is an open-source project dedicated to empowering you to take control of your web content. In an age where traditional RSS feeds are often missing, `html2rss` provides a robust and flexible solution to convert almost any HTML content into a structured RSS format.
 
-The project was started in 2018 and has since grown into a suite of tools that help users create and consume RSS feeds.
+Started in 2018, the project has evolved into a comprehensive suite of tools designed to help you create and consume RSS feeds effortlessly.
 
 ---
 
-### Our Mission
+## Our Vision and Principles
 
 Our mission is to provide a simple, powerful, and accessible tool that enables individuals and developers to create custom RSS feeds from any web page. We believe in the power of open standards and the freedom to access information on your own terms.
 
----
-
-### The html2rss Ecosystem
-
-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:
-
-- **[`html2rss`](https://github.com/html2rss/html2rss):** The core Ruby gem that provides the main functionality for converting HTML to RSS.
-- **[`html2rss-web`](https://github.com/html2rss/html2rss-web):** A web application that allows you to create and manage your RSS feeds through a user-friendly interface.
-- **[`html2rss-configs`](https://github.com/html2rss/html2rss-configs):** A collection of pre-built feed configs for popular websites, so you can get started quickly.
-
----
+Our project is guided by these core principles:
 
-### Project Philosophy
+- **User Empowerment:** Giving you the tools to customize your web experience.
+- **Simplicity & Power:** Offering an easy-to-use interface with powerful underlying capabilities.
+- **Open Source:** Fostering a collaborative environment where the community can contribute and improve the project.
+- **Reliability:** Striving for a stable and dependable tool that consistently delivers.
 
-- **User Empowerment:** Give users the tools to customize their web experience.
-- **Simplicity & Power:** Offer an easy-to-use interface with powerful underlying capabilities.
-- **Open Source:** Foster a collaborative environment where the community can contribute and improve the project.
-- **Reliability:** Strive for a stable and dependable tool that consistently delivers.
+For insights into our ongoing development, project roadmap, and how you can get involved, please visit our [Get Involved]({{ '/get-involved' | relative_url }}) page.
 
 ---
 

contributing.md get-involved/contributing.mdcontributing.md renamed to get-involved/contributing.md

@@ -1,6 +1,7 @@
 ---
 layout: default
 title: Contributing
+parent: Get Involved
 nav_order: 10
 ---
 
@@ -44,14 +45,20 @@ Are you a Ruby developer? You can help us improve the core `html2rss` gem. Wheth
 
 [**Check out the repository on GitHub**](https://github.com/html2rss/html2rss)
 
-### 5. Report Bugs and Request Features
+### 5. Report Bugs & Discuss Features
 
-If you've found a bug or have an idea for a new feature, please let us know! You can open an issue on the appropriate GitHub repository.
+If you've found a bug, please open an issue on the appropriate GitHub repository. For new feature ideas, we encourage you to start a discussion first.
+
+**Report Bugs:**
 
 - [**`html2rss` issues**](https://github.com/html2rss/html2rss/issues)
 - [**`html2rss-web` issues**](https://github.com/html2rss/html2rss-web/issues)
 - [**`html2rss-configs` issues**](https://github.com/html2rss/html2rss-configs/issues)
 
+**Discuss Features:**
+
+- [**Start a New Discussion on GitHub**](https://github.com/orgs/html2rss/discussions)
+
 ---
 
 We appreciate your interest in contributing to `html2rss`!

get-involved/discussions.md

@@ -0,0 +1,15 @@
+---
+layout: default
+title: Join Community Discussions
+nav_order: 2
+parent: Get Involved
+permalink: /get-involved/discussions
+---
+
+# Join Community Discussions
+
+Connect with other users and contributors by joining our community discussions on GitHub. This is a vibrant space for general questions, sharing tips, discussing ideas, and getting feedback from the community.
+
+[**💬 Join Discussions on GitHub**](https://github.com/orgs/html2rss/discussions)
+
+We encourage you to participate, ask questions, and share your insights!

get-involved/index.md

@@ -0,0 +1,21 @@
+---
+layout: default
+title: Get Involved
+has_children: true
+nav_order: 4
+---
+
+# Get Involved
+
+Want to participate in the `html2rss` project? Explore the options below to engage with our community and contribute to the project's growth.
+
+---
+
+- [**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.
+- [**Join Community Discussions**]({{ '/get-involved/discussions' | relative_url }}): Connect with other users and contributors, ask questions, and share ideas.
+- [**Contribute to html2rss**]({{ '/contributing' | relative_url }}): Ready to contribute code, documentation, or feed configurations? Find detailed guides here.
+- [**📊 View Project Roadmap & Tasks**]({{ 'https://github.com/orgs/html2rss/projects/3/views/1' }}): See what's being worked on, planned, and needs attention across all `html2rss` projects.
+
+---
+
+We appreciate your interest in `html2rss` and look forward to your involvement!

get-involved/issues-and-features.md

@@ -0,0 +1,38 @@
+---
+layout: default
+title: Report Bugs & Discuss Features
+nav_order: 1
+parent: Get Involved
+permalink: /get-involved/issues-and-features
+---
+
+# Report Bugs & Discuss Features
+
+We appreciate your help in improving `html2rss`! Please follow these guidelines when reporting issues or suggesting new features.
+
+---
+
+### Reporting Bugs
+
+If you've found a bug, please open an issue on the appropriate GitHub repository. This helps us track and resolve problems efficiently.
+
+[**➡️ Open an Issue on GitHub**](https://github.com/html2rss/html2rss/issues)
+
+When opening a bug report, please provide as much detail as possible, including:
+
+- The `html2rss` version you are using.
+- Your operating system.
+- Your configuration file (if applicable).
+- The target URL you are trying to scrape.
+- Any error messages you receive.
+- Steps to reproduce the issue.
+
+---
+
+### Discussing New Features
+
+For new feature ideas or enhancements, we encourage you to start a discussion on GitHub Discussions first. This allows for community input, refinement of the idea, and helps us prioritize development.
+
+[**💬 Start a New Discussion on GitHub**](https://github.com/orgs/html2rss/discussions)
+
+If the discussion leads to a concrete proposal, a formal feature request issue can then be opened.

index.md

@@ -12,30 +12,23 @@ Tired of missing updates from websites that don't offer RSS feeds? `html2rss` is
 
 ---
 
-## The html2rss Ecosystem
-
-`html2rss` is a suite of tools designed to help you create and manage RSS feeds.
-
-- **[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.
-- **[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.
-- **[html2rss-configs](https://github.com/html2rss/html2rss-configs):** A community-driven repository of pre-built feed configurations for popular websites.
-
----
-
 ## Key Features
 
-- **User-Friendly Web Interface:** The `html2rss-web` application provides a simple and intuitive interface for managing your feeds.
 - **Automatic Feed Generation:** The `auto_source` scraper intelligently finds and extracts content from websites, so you can create feeds with minimal effort.
 - **Precise Content Extraction:** Use familiar CSS selectors to target the exact content you want to include in your feed.
 - **JavaScript Rendering:** Use a headless browser to render JavaScript-heavy websites and extract content that isn't available in the initial HTML.
 - **Open Source:** `html2rss` is free to use, modify, and contribute to.
 
 ---
 
-### Join the Community
+## The html2rss Ecosystem
+
+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:
 
-Have a question, an idea, or a success story to share? Join the `html2rss` community on GitHub!
+- **[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.
+- **[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.
+- **[html2rss-configs](https://github.com/html2rss/html2rss-configs):** A community-driven repository of pre-built feed configurations for popular websites, so you can get started quickly.
+
+---
 
-- **[Discussions](https://github.com/orgs/html2rss/discussions):** Ask questions, share ideas, and connect with other users.
-- **[Issues](https://github.com/html2rss/html2rss/issues):** Report bugs and request new features.
-- **[Contribute](https://github.com/html2rss/html2rss/fork):** Fork the repository and submit your own improvements.
+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.

ruby-gem/configuration/index.md

@@ -1,10 +1,10 @@
 ---
 layout: default
 title: Advanced Content Extraction
-nav_order: 1
-parent: Examples
+nav_order: 3
+parent: How-To Guides
 grand_parent: Ruby Gem
-permalink: /ruby-gem/examples/advanced-content-extraction
+permalink: /ruby-gem/how-to/advanced-content-extraction
 ---
 
 # Advanced Content Extraction with Selectors
@@ -13,8 +13,8 @@ While basic selectors are straightforward, you can achieve very precise content
 
 ## Extractors
 
-Learn how to extract specific attributes (like `src` for images) or static values. See [Extractors]({{ '/ruby-gem/configuration/selectors/extractors' | relative_url }}).
+Learn how to extract specific attributes (like `src` for images) or static values. See [Extractors]({{ '/ruby-gem/reference/selectors/extractors' | relative_url }}).
 
 ## Post Processors
 
-Manipulate extracted text, sanitize HTML, convert Markdown, or apply custom logic. See [Post Processors]({{ '/ruby-gem/configuration/selectors/post-processors' | relative_url }}).
+Manipulate extracted text, sanitize HTML, convert Markdown, or apply custom logic. See [Post Processors]({{ '/ruby-gem/reference/selectors/post-processors' | relative_url }}).

…/examples/advanced-content-extraction.md …em/how-to/advanced-content-extraction.mdruby-gem/examples/advanced-content-extraction.md renamed to ruby-gem/how-to/advanced-content-extraction.md ruby-gem/examples/advanced-content-extraction.md renamed to ruby-gem/how-to/advanced-content-extraction.md

@@ -2,9 +2,9 @@
 layout: default
 title: Creating Custom Feeds
 nav_order: 1
-permalink: /web-application/guides/creating-custom-feeds
-parent: Guides
-grand_parent: Web Application
+permalink: /web-application/how-to/creating-custom-feeds
+parent: How-To Guides
+grand_parent: Ruby Gem
 ---
 
 # Creating Your First Custom Feed

…lication/guides/creating-custom-feeds.md ruby-gem/how-to/creating-custom-feeds.mdweb-application/guides/creating-custom-feeds.md renamed to ruby-gem/how-to/creating-custom-feeds.md web-application/guides/creating-custom-feeds.md renamed to ruby-gem/how-to/creating-custom-feeds.md

@@ -1,10 +1,10 @@
 ---
 layout: default
 title: Custom HTTP Requests
-nav_order: 2
-parent: Examples
+nav_order: 4
+parent: How-To Guides
 grand_parent: Ruby Gem
-permalink: /ruby-gem/examples/custom-http-requests
+permalink: /ruby-gem/how-to/custom-http-requests
 ---
 
 # Customizing HTTP Requests
@@ -13,4 +13,4 @@ You might need to send custom HTTP headers (e.g., `User-Agent`, `Authorization`)
 
 ## Solution
 
-Configure [custom HTTP headers]({{ '/ruby-gem/configuration/headers' | relative_url }}) in your feed configuration.
+Configure [custom HTTP headers]({{ '/ruby-gem/reference/headers' | relative_url }}) in your feed configuration.