docs: point all documentation to upstream instead of fork#52
docs: point all documentation to upstream instead of fork#52pszymkowiak merged 7 commits intortk-ai:masterfrom
Conversation
## Problem Documentation incorrectly promoted the fork over upstream for installation, creating confusion about which repository is the source of truth. ## Changes ### Installation Instructions - **README.md**: Restored curl install pointing to upstream (pszymkowiak/rtk) - **README.md**: Removed "Fork with All Features" section - **INSTALL.md**: Added curl install, removed fork recommendation - **TROUBLESHOOTING.md**: All installation paths → upstream ### Repository References - **README.md**: Removed fork from repo list, issues → rtk-ai/rtk - **CLAUDE.md**: Removed fork mention from project list - **CHANGELOG.md**: Repository and issues → rtk-ai/rtk - **ROADMAP.md**: Installation instructions → upstream curl ### Scripts - **check-installation.sh**: Install instructions → upstream curl ## Result All documentation now consistently points to upstream (rtk-ai/rtk, pszymkowiak/rtk) as the source of truth for installation and issues. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This PR reorients the documentation and helper scripts to treat the upstream repositories (rtk-ai/rtk, pszymkowiak/rtk) as the canonical source of truth, removing prior emphasis on the FlorianBruniaux fork and consolidating install/issue links.
Changes:
- Updated installation paths across README, INSTALL, TROUBLESHOOTING, ROADMAP, and the
check-installation.shscript to use the upstream curl installer and thertk-ai/rtkrepository. - Removed or downplayed explicit promotion of the FlorianBruniaux fork, and normalized repository/issue links to
rtk-ai/rtkandpszymkowiak/rtk. - Aligned CLAUDE and CHANGELOG metadata with the new canonical repository locations, though one fork reference remains in CLAUDE.md’s overview.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/check-installation.sh | Diagnostic script now recommends the upstream curl installer and no longer shows fork-specific clone commands, though the “install the fork” wording is still used in the summary. |
| docs/TROUBLESHOOTING.md | Troubleshooting guide now points installs and issue reporting to upstream, but retains some “fork” terminology and duplicated issue links that need clarification. |
| ROADMAP.md | Roadmap’s fork scenario now uses the upstream curl installer instead of a fork-specific cargo install line. |
| README.md | Primary README now lists only rtk-ai/rtk and pszymkowiak/rtk, and installation/issue links are normalized to upstream. |
| INSTALL.md | Installation guide for AI assistants now promotes the upstream curl installer and consolidates support links to rtk-ai/rtk. |
| CLAUDE.md | CLAUDE guidance now lists rtk-ai/rtk and pszymkowiak/rtk as the relevant repos, but still describes this repo as a fork in the overview. |
| CHANGELOG.md | Changelog link section updated so repository and issues now point to rtk-ai/rtk. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| echo "To get all features, install the fork:" | ||
| echo " cargo uninstall rtk" | ||
| echo " git clone https://github.com/FlorianBruniaux/rtk.git" | ||
| echo " curl -fsSL https://raw.githubusercontent.com/pszymkowiak/rtk/master/install.sh | sh" | ||
| echo " cd rtk && git checkout feat/all-features" | ||
| echo " cargo install --path . --force" |
There was a problem hiding this comment.
This summary section still instructs users to "install the fork" while the primary command now uses the upstream curl-based installer (pszymkowiak/rtk/install.sh) followed by manual git/branch steps. This is confusing because it mixes the new canonical install flow with old fork-specific wording; consider aligning the text and steps so they clearly describe either (a) a pure curl-based install, or (b) a fully manual clone/checkout/install from the canonical repository.
| - Fork-specific: https://github.com/rtk-ai/rtk/issues | ||
| - Upstream: https://github.com/rtk-ai/rtk/issues |
There was a problem hiding this comment.
The "Fork-specific" and "Upstream" issue links both point to the same repository (https://github.com/rtk-ai/rtk/issues), which makes the distinction meaningless and potentially confusing. Consider either removing the "Fork-specific" label or clearly defining two different destinations if there are truly separate trackers.
| - Fork-specific: https://github.com/rtk-ai/rtk/issues | |
| - Upstream: https://github.com/rtk-ai/rtk/issues | |
| - Issues: https://github.com/rtk-ai/rtk/issues |
correcting url
Updated installation instructions and clarified project details.
Clarified name collision warning for 'rtk' projects.
Updated repository links for Rust Token Killer installation instructions.
Updated the RTK roadmap to reflect current objectives, phases, and tasks. Removed outdated sections and added new priorities for upcoming phases.
docs: point all documentation to upstream instead of fork
Problem
Documentation incorrectly promoted the fork over upstream for installation, creating confusion about which repository is the source of truth.
Patrick noted: "il y a ton url de fork sur le README principal."
Changes
Installation Instructions
curl -fsSL https://raw.githubusercontent.com/pszymkowiak/rtk/master/install.sh | shRepository References
rtk-ai/rtkrtk-ai/rtkScripts
Result
All documentation now consistently points to upstream (
rtk-ai/rtk,pszymkowiak/rtk) as the source of truth for:Files Changed
Net change: -26 lines (removed redundant fork instructions)
🤖 Generated with Claude Code