docs: update and provide correct information #941
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request makes significant improvements to the documentation and user experience for the html2rss project. The main focus is on clarifying instructions, making guides more beginner-friendly, updating navigation and terminology, and enhancing error handling. The changes span the main landing page, guides for both the web application and Ruby gem, configuration documentation, and the 404 error page.
Documentation and Getting Started Improvements
index.mdandweb-application/getting-started.mdto provide clearer explanations of RSS, html2rss, and getting started options for both beginners and advanced users. The landing page now better distinguishes between html2rss-web and the Ruby gem, and emphasizes the Feed Directory for new users. [1] [2]html2rss-configs/index.mdto use simpler, friendlier language and a step-by-step approach for creating custom RSS feeds, including improved explanations of YAML configuration and selectors. [1] [2] [3] [4] [5] [6] [7]Navigation and Link Updates
/get-involved/contributingpath instead of/contributingfor consistency and improved navigation. [1] [2]Feature Documentation and Reference Enhancements
web-application/how-to/use-automatic-feed-generation.md, including step-by-step instructions for enabling and using the feature.ruby-gem/reference/selectors.md, including new columns and examples for attributes and static values, and clarified enclosure usage. [1] [2] [3].xls→.xsl) inruby-gem/reference/stylesheets.md.ruby-gem/how-to/scraping-json.md.Error Handling and User Guidance
404.htmlerror page with a more helpful message and links to key resources, improving user experience when encountering broken links.