Skip to content

rubydoc: fix index page#21637

Merged
MikeMcQuaid merged 1 commit intoHomebrew:mainfrom
GunniBusch:fix/rubydoc-index
Feb 27, 2026
Merged

rubydoc: fix index page#21637
MikeMcQuaid merged 1 commit intoHomebrew:mainfrom
GunniBusch:fix/rubydoc-index

Conversation

@GunniBusch
Copy link
Contributor

@GunniBusch GunniBusch commented Feb 27, 2026

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same change?
  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes? Here's an example.
  • Have you successfully run brew lgtm (style, typechecking and tests) with your changes locally?

  • AI was used to generate or assist with generating this PR. Please specify below how you used AI to help you, and what steps you have taken to manually verify the changes.

As mentioned #21589 (comment) the index page did return a 404.

This was because there was no index page, since the index page is _index.html Jekyll excluded it, so I made a include in the config file, and now it works.

Copilot AI review requested due to automatic review settings February 27, 2026 14:57
Copy link
Contributor

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 fixes a 404 error on the RubyDoc index page by configuring Jekyll to include HTML files starting with underscores. YARD (the Ruby documentation generator) creates files like _index.html that Jekyll excludes by default, causing the 404 errors mentioned in PR #21589. The fix adds a simple include directive to the Jekyll configuration file.

Changes:

  • Added include configuration to docs/_config.yml to explicitly include _*.html files that would otherwise be excluded by Jekyll's default behavior

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Member

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

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

Thanks!

@MikeMcQuaid MikeMcQuaid added this pull request to the merge queue Feb 27, 2026
Merged via the queue into Homebrew:main with commit fc785ec Feb 27, 2026
39 of 40 checks passed
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.

3 participants