Skip to content

Remove outdated GitHub Packages token workaround from troubleshooting docs#2325

Merged
ihabadham merged 1 commit intomasterfrom
ihabadham/fix/remove-outdated-token-workaround
Jan 29, 2026
Merged

Remove outdated GitHub Packages token workaround from troubleshooting docs#2325
ihabadham merged 1 commit intomasterfrom
ihabadham/fix/remove-outdated-token-workaround

Conversation

@ihabadham
Copy link
Copy Markdown
Collaborator

@ihabadham ihabadham commented Jan 29, 2026

Summary

  • Removed the obsolete "Invalid Token Workaround" section from react_on_rails_pro/docs/troubleshooting.md
  • Added a pointer to the Upgrading Guide for migration-related issues

The removed section referenced the old private distribution model (GitHub Packages) which was replaced with public distribution (npmjs.org / RubyGems.org) in #1901. It also contained broken links to installation.md anchors (#using-a-branch-in-your-gemfile and #instructions-for-using-a-branch) that were removed during the rewrite.

Test plan

  • Verify the relative link to updating.md resolves correctly on GitHub

Closes #2321

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated troubleshooting documentation by consolidating token-related issue guidance, directing users to the Upgrading Guide for assistance with distribution-related concerns.

✏️ Tip: You can customize this high-level summary in your review settings.

… docs

The "Invalid Token Workaround" section referenced the old private
distribution model (GitHub Packages) which was replaced with public
distribution (npmjs.org / RubyGems.org) in #1901. The section also
contained broken links to installation.md anchors that no longer exist.

Replace with a pointer to the upgrading guide for migration-related issues.

Closes #2321

Co-Authored-By: Claude Opus 4.5 <[email protected]>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jan 29, 2026

Walkthrough

Removed the outdated "Invalid Token Workaround" section from troubleshooting documentation that referenced deprecated GitHub Packages distribution. Replaced it with a single line directing users to the Upgrading Guide for token and installation issues.

Changes

Cohort / File(s) Summary
Documentation Update
react_on_rails_pro/docs/troubleshooting.md
Removed 25-line "Invalid Token Workaround" section with obsolete GitHub Packages setup instructions and broken cross-references. Replaced with single-line reference to Upgrading Guide.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

  • #2300: Documentation migration away from GitHub Packages distribution model with consistent guidance redirecting to Upgrading Guide.

Possibly related PRs

Suggested labels

review-needed

Suggested reviewers

  • justin808
  • AbanoubGhadban
  • Romex91

Poem

🐰 Old token woes now put to rest,
The docs are tidied, looking best!
GitHub Packages fade away,
To the Upgrade Guide—hop, hooray! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately and concisely describes the main change: removing an outdated GitHub Packages token workaround section from the troubleshooting documentation.
Linked Issues check ✅ Passed The PR satisfies all coding requirements from issue #2321: removes the outdated 'Invalid Token Workaround' section and broken anchor links, and adds a pointer to the Upgrading Guide.
Out of Scope Changes check ✅ Passed All changes are directly related to the scope defined in issue #2321; no unrelated modifications are present in the PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch ihabadham/fix/remove-outdated-token-workaround

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

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

@claude
Copy link
Copy Markdown
Contributor

claude Bot commented Jan 29, 2026

Code Review: Documentation Cleanup ✅

Overall Assessment: LGTM - Excellent documentation cleanup

This PR correctly removes outdated content and improves documentation accuracy. The change is well-scoped and appropriate.


Strengths

  1. Correct Problem Identification

    • The "Invalid Token Workaround" section is indeed obsolete after PR Switch Pro packages to public distribution #1901 migrated from GitHub Packages to public distribution (Nov 2025)
    • The section referenced broken anchor links (#using-a-branch-in-your-gemfile, #instructions-for-using-a-branch) that no longer exist
    • The GitHub PAT workaround is no longer relevant for the current license-based authentication model
  2. Appropriate Replacement

    • Replaced with a pointer to updating.md which contains the correct migration instructions from GitHub Packages to public distribution
    • Relative link format ./updating.md is consistent with other docs in the codebase (verified against multiple examples in docs/release-notes/)
    • The link target exists and contains relevant content at react_on_rails_pro/docs/updating.md
  3. Documentation Hygiene


📋 Test Plan Completion

The PR's test plan asks to "Verify the relative link to updating.md resolves correctly on GitHub."

Verification:

  • ✅ File exists: react_on_rails_pro/docs/updating.md (7746 bytes)
  • ✅ Relative link format matches codebase conventions (checked against 10+ other docs)
  • ✅ The link will resolve correctly on GitHub (same directory, standard relative path)

🔍 Additional Context Verified

  1. Checked updating.md content - Contains proper migration instructions for GitHub Packages → public distribution
  2. Searched for other GitHub Packages references - All properly handled in updating.md and installation.md
  3. Reviewed PR Switch Pro packages to public distribution #1901 - Confirms the migration context and why this section is now obsolete

📝 Notes

  • No changelog entry needed: Per CLAUDE.md, documentation fixes don't require changelog updates
  • No breaking changes: Pure documentation cleanup
  • No code changes: Zero risk to functionality

Recommendation: Approve and Merge

This is a straightforward, well-executed documentation cleanup that removes obsolete content and improves user experience. The replacement link is correct and the change is fully justified by the historical context (PR #1901).

Ready to merge once CI passes.

@greptile-apps
Copy link
Copy Markdown

greptile-apps Bot commented Jan 29, 2026

Greptile Overview

Greptile Summary

Removed obsolete "Invalid Token Workaround" section from troubleshooting documentation. The removed content referenced the old GitHub Packages distribution model (replaced in PR #1901) and contained broken links to installation.md anchors that no longer exist. Replaced with a concise pointer to the comprehensive Upgrading Guide.

Changes:

  • Removed 26 lines of outdated GitHub Packages token workaround instructions
  • Added single-line redirect to updating.md for migration-related issues
  • Relative link ./updating.md correctly resolves in the same directory structure
  • The updating guide comprehensively covers GitHub Packages → public distribution migration

Confidence Score: 5/5

  • This PR is safe to merge with minimal risk - it only removes obsolete documentation
  • Documentation-only change that removes obsolete content and fixes broken links. The removed section referenced the deprecated GitHub Packages distribution model (replaced in PR Switch Pro packages to public distribution #1901), and the links it contained (#using-a-branch-in-your-gemfile and #instructions-for-using-a-branch) no longer exist in installation.md. The replacement link to updating.md is valid and provides comprehensive migration guidance.
  • No files require special attention

Important Files Changed

Filename Overview
react_on_rails_pro/docs/troubleshooting.md Removed obsolete GitHub Packages token workaround section, added link to updating guide

Sequence Diagram

sequenceDiagram
    participant User
    participant TroubleshootingDoc as troubleshooting.md
    participant UpdatingDoc as updating.md
    
    User->>TroubleshootingDoc: Encounters migration issue
    Note over TroubleshootingDoc: Old: Invalid Token Workaround<br/>section with GitHub Packages<br/>instructions (REMOVED)
    TroubleshootingDoc->>UpdatingDoc: Redirects via relative link
    Note over UpdatingDoc: Comprehensive guide for<br/>GitHub Packages → Public<br/>distribution migration
    UpdatingDoc->>User: Provides complete migration steps
Loading

@ihabadham ihabadham merged commit c5d1c23 into master Jan 29, 2026
4 of 5 checks passed
@ihabadham ihabadham deleted the ihabadham/fix/remove-outdated-token-workaround branch January 29, 2026 12:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Remove or update outdated 'Invalid Token Workaround' section in troubleshooting.md

1 participant