Skip to content

feat: make central place for documentation #917

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Aug 2, 2025

Conversation

gildesmarais
Copy link
Member

@gildesmarais gildesmarais commented Jul 20, 2025

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 the fix target with new lint and lintfix targets, 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 new feed-directory functionality.

Style Improvements:

  • assets/css/main.scss: Added a new feed-directory SCSS file for styling the feed directory.
  • assets/css/sass/base.scss: Removed unused styles and added transitions for details and summary elements.
  • 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.

@gildesmarais gildesmarais requested a review from Copilot July 20, 2025 13:09
Copilot

This comment was marked as outdated.

@html2rss html2rss deleted a comment from Copilot AI Jul 20, 2025
Signed-off-by: Gil Desmarais <git@desmarais.de>
@gildesmarais gildesmarais force-pushed the feat/825-documentation-content branch from de48833 to 266f5e1 Compare July 20, 2025 13:22
@gildesmarais gildesmarais requested a review from Copilot July 20, 2025 13:23
Copilot

This comment was marked as outdated.

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>
@gildesmarais gildesmarais force-pushed the feat/825-documentation-content branch from 59b4fa2 to 1c77011 Compare August 2, 2025 11:21
@gildesmarais gildesmarais changed the title Add content of gem README feat: make central place for documentation Aug 2, 2025
Copilot

This comment was marked as outdated.

Signed-off-by: Gil Desmarais <git@desmarais.de>
@gildesmarais gildesmarais force-pushed the feat/825-documentation-content branch from 965229f to beba042 Compare August 2, 2025 14:00
@gildesmarais gildesmarais requested a review from Copilot August 2, 2025 14:01
Copilot

This comment was marked as outdated.

@html2rss html2rss deleted a comment from Copilot AI Aug 2, 2025
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Gil Desmarais <git@desmarais.de>
@gildesmarais gildesmarais force-pushed the feat/825-documentation-content branch from 87dd7a4 to 0c89e8a Compare August 2, 2025 14:06
@gildesmarais gildesmarais requested a review from Copilot August 2, 2025 14:07
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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",

@gildesmarais gildesmarais marked this pull request as ready for review August 2, 2025 14:10
@gildesmarais gildesmarais merged commit e004d7c into main Aug 2, 2025
4 checks passed
@gildesmarais gildesmarais deleted the feat/825-documentation-content branch August 2, 2025 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant