Repository navigation
docs: link each example file from the README - #41
Merged
Merged
Conversation
The README linked the examples only through the folder URL (/tree/main/...). https://github.com/robots.txt disallows /*/tree/ for Googlebot (User-agent: *) and for the AI crawlers, so search engines never read the folder listing. Each example file is now also linked by its /blob/ URL, which they may crawl. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues for the documentation-only update adding direct links to the library’s examples.
No open issues 🎉
What changed in this PR
Improves discoverability of the Ruby library’s examples by linking directly to individual files from the README.
Changes:
- Adds absolute links to six example files, each with a short description.
- Preserves the existing examples folder link and leaves the thumbnail example unlisted pending its separate fix.
| File | Description |
|---|---|
| README.md | Adds a descriptive list of direct example-file links; no code changes. |
Review effort: Balanced
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
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.
The README links the examples only through the folder URL (
/tree/main/examples). https://github.com/robots.txt disallows/*/tree/in theUser-agent: *group, which Googlebot follows, and in the group for GPTBot, OAI-SearchBot, ClaudeBot, anthropic-ai and PerplexityBot. Single-file/blob/URLs are allowed. So these crawlers never read the folder listing, and they only find an example file when some page links it directly.This PR keeps the folder link and adds a list under it: each example file, linked by its absolute
/blob/main/...URL, with a few words on what it does. Absolute URLs match the README's other links and also work where the README is shown outside GitHub.examples/create_pdf_thumbnail.rb. It still uses theextractconverter and has a separate fix pending; add it to the list once that fix is merged.🤖 Generated with Claude Code