feat: make central place for documentation #917
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Signed-off-by: Gil Desmarais <git@desmarais.de>
de48833 to
266f5e1
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
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`.
Signed-off-by: Gil Desmarais <git@desmarais.de>
59b4fa2 to
1c77011
Compare
This was referenced Aug 2, 2025
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Signed-off-by: Gil Desmarais <git@desmarais.de>
965229f to
beba042
Compare
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Gil Desmarais <git@desmarais.de>
87dd7a4 to
0c89e8a
Compare
There was a problem hiding this comment.
Pull Request Overview
This pull request creates a centralized documentation structure for the html2rss ecosystem, transitioning from a scattered site to a comprehensive knowledge base. The changes reorganize content into logical sections, improve navigation, and modernize the styling and tooling.
Key changes:
- Complete restructuring of documentation into Web Application, Ruby Gem, and support sections
- Migration from legacy configs listing to a modern Feed Directory with interactive features
- Enhanced build tooling with Prettier integration and improved linting workflows
Reviewed Changes
Copilot reviewed 70 out of 71 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| index.md/index.html | Complete homepage redesign from HTML to Markdown with clearer ecosystem overview |
| web-application/ | New comprehensive documentation section for the web application with installation guides and tutorials |
| ruby-gem/ | New structured documentation for the Ruby gem including tutorials and reference materials |
| feed-directory/index.html | Modern replacement for configs listing with interactive search and filtering |
| assets/js/feed-directory/ | New JavaScript functionality for the interactive feed directory |
| assets/css/sass/ | Updated styling including new feed-directory styles and base improvements |
| get-involved/ | New section consolidating community engagement and contribution guidelines |
| _config.yml, Makefile, package.json | Updated build configuration with Prettier integration and improved linting |
Comments suppressed due to low confidence (1)
package.json:13
- Prettier version 3.3.3 does not exist. The latest version in the 3.x series is 3.3.2. Consider using a valid version like "3.3.2" or check the latest available version.
"prettier": "3.3.3",
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 introduces significant updates to the repository, focusing on workflow enhancements, codebase cleanup, style improvements, and documentation updates. These changes aim to streamline development processes, improve maintainability, and enhance the user experience.
Workflow Enhancements:
.github/workflows/gh-pages.yml: Added concurrency settings to prevent overlapping runs and updated permissions for better security and functionality. [1] [2].github/workflows/lint.yml: Introduced a new linting workflow triggered on pull requests to ensure code quality.Codebase Cleanup:
Makefile: Replaced thefixtarget with newlintandlintfixtargets, adding support for Ruby linting and simplifying the linting process.assets/js/configs/index.js: Removed outdated JavaScript logic for handling configurations, replaced by the newfeed-directoryfunctionality.Style Improvements:
assets/css/main.scss: Added a newfeed-directorySCSS file for styling the feed directory.assets/css/sass/base.scss: Removed unused styles and added transitions fordetailsandsummaryelements.assets/css/sass/feed-directory.scss: Introduced styles for feed directory filters, items, and actions, enhancing the visual presentation of the feed directory.Documentation Updates:
README.md: Updated the repository description and added a "Contributing" section to encourage community involvement.about.md: Created a new "About html2rss" page detailing the project's vision, principles, and team information.components/html2rss-configs.md: Removed outdated content related to feed configurations.Configuration and Tooling Updates:
.prettierignore: Added common directories and files to ignore during formatting..prettierrc.json: Configured Prettier to use double quotes and trailing commas for better consistency..stylelintrc.json: Simplified Stylelint rules by removing unnecessary configurations.