Skip to content

docs: fix Global Rules directory location for Linux/WSL systems #5219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Jul 29, 2025
Merged

docs: fix Global Rules directory location for Linux/WSL systems #5219

merged 2 commits into from
Jul 29, 2025
+18 −1

Conversation

trupix
Copy link
Contributor

@trupix trupix commented Jul 28, 2025 •
edited by ellipsis-dev bot
Loading

Related Issue

Issue: #5153

Description

This PR fixes incorrect documentation for the Global Rules directory location on Linux/WSL systems. The previous documentation stated that Global Rules are universally stored in Documents/Cline/Rules, but on Linux/WSL systems, the actual location can vary and may fall back to ~/Cline/Rules/ depending on system configuration.

Changes made:

  • Added a platform-specific table showing correct paths for Windows, macOS, and Linux/WSL
  • Added a specific note for Linux/WSL users explaining the potential fallback location
  • Clarified that the location may vary depending on system configuration and whether the Documents directory exists

This addresses the confusion reported by users who couldn't find their Global Rules in the documented location on Linux systems.

Test Procedure

Testing approach:

  • Verified the documentation changes render correctly in the MDX format
  • Cross-referenced the code in src/core/storage/disk.ts to confirm the actual behavior matches the updated documentation
  • Confirmed that the getDocumentsPath() function does indeed have platform-specific logic that can result in different paths on Linux systems
  • Reviewed the ensureRulesDirectoryExists() function to understand the fallback behavior

What could potentially break:

  • This is a documentation-only change, so no functional code is affected
  • The change only clarifies existing behavior rather than changing it

Confidence level: High - this is a straightforward documentation correction that accurately reflects the existing codebase behavior.

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • ♻️ Refactor Changes
  • 💅 Cosmetic Changes
  • 📚 Documentation update
  • 🏃 Workflow Changes

Pre-flight Checklist

  • Changes are limited to a single feature, bugfix or chore (split larger changes into separate PRs)
  • Tests are passing (npm test) and code is formatted and linted (npm run format && npm run lint)
  • I have created a changeset using npm run changeset (required for user-facing changes)
  • I have reviewed contributor guidelines

Screenshots

Not applicable - this is a documentation text change only.

Additional Notes

This change helps Linux/WSL users who were confused by the previous documentation and couldn't locate their Global Rules files. The updated documentation provides clear guidance for all platforms and explains the potential variation on Linux systems.

Important

Fixes documentation for Global Rules directory on Linux/WSL, adding platform-specific paths and notes.

  • Documentation Update:
    • Corrects Global Rules directory location for Linux/WSL in cline-rules.mdx.
    • Adds platform-specific table for Windows, macOS, and Linux/WSL paths.
    • Includes note for Linux/WSL users about potential fallback to ~/Cline/Rules.
  • Verification:
    • Confirmed documentation matches behavior in src/core/storage/disk.ts.
    • Reviewed getDocumentsPath() and ensureRulesDirectoryExists() for path logic.

This description was created by Ellipsis for 026723b. You can customize this summary. It will automatically update as commits are pushed.

trupix added 2 commits July 28, 2025 15:45
@trupix
docs: fix Global Rules directory location for Linux/WSL systems
b52e789 
- Add platform-specific table showing correct paths for Windows, macOS, and Linux/WSL
- Add note for Linux/WSL users about potential fallback to ~/Cline/Rules/
- Addresses issue #5153 where documentation incorrectly stated universal Documents/Cline/Rules path

Fixes #5153
@trupix
Changeset
026723b
@Copilot Copilot AI review requested due to automatic review settings July 28, 2025 19:54
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 28, 2025

⚠️ No Changeset found

Latest commit: b52e789

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copilot
Copilot AI reviewed Jul 28, 2025
View reviewed changes
Copy link
Contributor

@Copilot 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 PR fixes incorrect documentation for Global Rules directory location on Linux/WSL systems. The previous documentation incorrectly stated that Global Rules are universally stored in Documents/Cline/Rules, but on Linux/WSL systems the location can vary based on system configuration.

  • Replaced generic documentation with a platform-specific table showing correct paths
  • Added specific guidance for Linux/WSL users about potential fallback location
  • Clarified that location varies based on system configuration and Documents directory existence

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 28, 2025 •
edited
Loading

Coverage Report

Extension Coverage

Base branch: 46%

PR branch: 47%

✅ Coverage increased or remained the same

Webview Coverage

Base branch: 17%

PR branch: 17%

✅ Coverage increased or remained the same

Overall Assessment

✅ Test coverage has been maintained or improved

Last updated: 2025-07-28T20:02:41.867950

@trupix trupix merged commit 099bc44 into main Jul 29, 2025
13 checks passed
@trupix trupix mentioned this pull request Aug 6, 2025
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@dcbartlett dcbartlett dcbartlett approved these changes

@saoudrizwan saoudrizwan Awaiting requested review from saoudrizwan

@ocasta181 ocasta181 Awaiting requested review from ocasta181

@NightTrek NightTrek Awaiting requested review from NightTrek

@pashpashpash pashpashpash Awaiting requested review from pashpashpash

@saito-sv saito-sv Awaiting requested review from saito-sv

@Garoth Garoth Awaiting requested review from Garoth

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@trupix @dcbartlett