Fix README CI badges and add prominent docs link

[justin808]

Problem

The four CI status badges at the top of the README were rendering blank ("no status"):

Ruby based checks · Jest specs · Rubocop · JS lint

They used the legacy workflow-name badge URLs (/workflows/<Name>/badge.svg). Only Ruby based checks still matched a real workflow. There are no longer standalone workflows named Jest specs, Rubocop, or JS lint — Jest and ESLint are jobs inside Node based checks (node.yml), and RuboCop is a job inside Ruby based checks (ruby.yml). GitHub badges are per-workflow (not per-job), so those three showed "no status".

Fix

Repoint all four badges to real workflows that run on main, using the current file-path badge URL format so each reports live pass/fail status and links to its workflow runs:

Badge	Workflow	Covers
Ruby based checks	ruby.yml	Ruby specs, RuboCop, RBS
Node based checks	node.yml	Jest, ESLint (JS lint), Prettier, TypeScript
Generator specs	generator.yml	Installer/generator specs
Test Both Bundlers	test-bundlers.yml	webpack + Rspack dummy-app specs

RuboCop / JS lint / Jest are surfaced through the umbrella workflows that actually own those jobs.

Verified the new badge endpoints return real status (passing/failing) instead of no status.

Docs link

Added a large, bold 📖 Read the Docs button near the top linking to shakapacker.com/docs, and removed the now-redundant inline "Full documentation lives at…" sentence in the intro (the dedicated Documentation section below still has it).

🤖 Generated with Claude Code

---

Note

Low Risk
Documentation and badge URL changes only; no runtime, CI workflow, or application code is modified.

Overview
Updates the README so CI status badges reflect real GitHub Actions workflows and the docs site is easier to find from the top of the page.

CI badges are switched from legacy workflow-name URLs (which left Jest specs, Rubocop, and JS lint showing “no status”) to the current actions/workflows/<file>.yml/badge.svg links for Ruby based checks, Node based checks, Generator specs, and Test Both Bundlers, each pointing at the matching workflow run page.

A centered Read the Docs shield button links to shakapacker.com/docs. The redundant intro sentence that duplicated that link is removed; the Documentation section below is unchanged.

^{Reviewed by Cursor Bugbot for commit 099b961. Bugbot is set up for automated code reviews on this repo. Configure here.}

[coderabbitai]

Warning

Review limit reached

@justin808, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 7 minutes and 6 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 51c1cc41-a2c6-4ded-a4fa-a42c20718cc3

📥 Commits

Reviewing files that changed from the base of the PR and between d602ede and 099b961.

📒 Files selected for processing (1)

• README.md

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch jg-conductor/readme-badges-docs-link

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[greptile-apps]

Greptile Summary

This PR fixes four CI status badges in the README that were rendering as "no status" because they used the legacy /workflows/<Name>/badge.svg format with names that no longer matched real workflows. It replaces them with the current /actions/workflows/<file>.yml/badge.svg format pointing to four verified workflow files. A prominent "Read the Docs" shield badge is also added near the top.

• All four referenced workflow files (ruby.yml, node.yml, generator.yml, test-bundlers.yml) exist in .github/workflows/, confirming the new badge URLs are valid.
• The redundant inline docs sentence ("Full documentation lives at…") is removed since the new button and the existing Documentation section already cover it.

Confidence Score: 5/5

README-only change that corrects broken badge URLs and adds a docs link button — no code, logic, or configuration is touched.

All four workflow files referenced by the new badge URLs exist in .github/workflows/. The badge URL format change from legacy name-based to file-path-based is the correct GitHub-documented approach. No functional code is affected.

No files require special attention.

Important Files Changed

Filename	Overview
README.md	Replaces broken legacy workflow-name badge URLs with correct file-path badge URLs pointing to existing workflow files, adds a "Read the Docs" button, and removes a now-redundant docs link sentence.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[README.md badge click] --> B{Badge URL format}
    B -- Old: /workflows/Name/badge.svg --> C[GitHub resolves by workflow name]
    C --> D{Name match?}
    D -- Jest specs / Rubocop / JS lint --> E[❌ No status - workflow not found]
    D -- Ruby based checks --> F[✅ Status shown]
    B -- New: /actions/workflows/file.yml/badge.svg --> G[GitHub resolves by file path]
    G --> H{File exists?}
    H -- ruby.yml / node.yml / generator.yml / test-bundlers.yml --> I[✅ Live pass/fail status]

Loading

_{Reviews (1): Last reviewed commit: "Fix CI badges and add prominent docs lin..." | Re-trigger Greptile}

[chatgpt-codex-connector]

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.