Add content of gem README #917
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Signed-off-by: Gil Desmarais <[email protected]>
gildesmarais
force-pushed
the
feat/825-documentation-content
branch
from
de48833 to
266f5e1
Compare
There was a problem hiding this comment.
Pull Request Overview
This pull request adds comprehensive documentation content for the html2rss gem's website, replacing minimal placeholder content with detailed user guides, configuration documentation, examples, and support resources. The changes transform the site from a basic component-focused structure to a complete user-focused documentation portal.
Key Changes:
- Complete restructure from component-based navigation to user-focused documentation sections
- Addition of comprehensive getting started guides, configuration documentation, and troubleshooting resources
- Replacement of HTML index page with markdown-based welcome page featuring improved user experience
Reviewed Changes
Copilot reviewed 31 out of 31 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| index.md | New welcome page with feature overview and navigation to key sections |
| index.html | Removed old HTML-based homepage |
| getting-started/ | Complete getting started section with installation and first feed guides |
| configuration/ | Comprehensive configuration documentation covering all options and scrapers |
| examples/ | Practical examples and use cases for common scenarios |
| support/ | Troubleshooting guide and contact information |
| contributing.md | Enhanced contributing guide with multiple contribution pathways |
| api-reference.md | New API reference section |
| about.md | New about page describing the project mission and ecosystem |
| configs/index.html | Updated title for ready-to-use configs |
| components/ | Removed old component documentation files |
| - `~/.rbenv/shims` (if using rbenv) | ||
| - `~/.rvm/bin` (if using RVM) | ||
| - `/usr/local/bin` | ||
| - A directory specific to your Ruby installation (e.g., `/usr/bin/gem`). |
There was a problem hiding this comment.
The path /usr/bin/gem is incorrect - this would be the path to the gem executable, not the directory where gem executables are installed. Consider using a more accurate example like /usr/bin or explaining that users should check where their gem executables are actually installed.
| - A directory specific to your Ruby installation (e.g., `/usr/bin/gem`). | |
| - A directory specific to your Ruby installation (e.g., `~/.gem/ruby/X.X.X/bin`, where `X.X.X` is your Ruby version). |
Copilot uses AI. Check for mistakes.
configuration/strategy.md
Outdated
| > [!TIP] | ||
| > When running locally with commands from above, you can skip setting the environment variables, as they are aligned with the default values from above example. |
There was a problem hiding this comment.
The > [!TIP] syntax is GitHub Flavored Markdown specific and may not render correctly in Jekyll. Consider using standard markdown blockquotes or Jekyll-specific syntax for callouts.
| > [!TIP] | |
| > When running locally with commands from above, you can skip setting the environment variables, as they are aligned with the default values from above example. | |
| > **Tip:** When running locally with commands from above, you can skip setting the environment variables, as they are aligned with the default values from above example. |
Copilot uses AI. Check for mistakes.
Reorganize the documentation to create a clear distinction between the `html2rss` Ruby Gem and the standalone Web Application. This improves navigation and helps users find content relevant to their specific use case. - Move all existing gem-related documentation (getting started, configuration, examples) into a new `/ruby-gem` directory. - Add a new, comprehensive documentation section for the Web Application under `/web-application`. - Update site-wide navigation, internal links, and page front matter to align with the new structure. - Update gem dependencies in `Gemfile.lock`.
No description provided.