fix(docs): replace ~/.squad/ with platform-specific path references#345
Closed
jsturtevant wants to merge 1 commit intobradygaster:mainfrom
Closed
fix(docs): replace ~/.squad/ with platform-specific path references#345jsturtevant wants to merge 1 commit intobradygaster:mainfrom
jsturtevant wants to merge 1 commit intobradygaster:mainfrom
Conversation
Closes bradygaster#343 Replaces hardcoded `~/.squad/` references throughout documentation and code comments with platform-aware descriptions. The SDK correctly resolves personal squad paths via `resolveGlobalSquadPath()`: - Linux: `~/.config/squad/` - macOS: `~/Library/Application Support/squad/` - Windows: `%APPDATA%\squad\` However, docs were consistently using `~/.squad/` which doesn't match any platform's actual path. Changed: - personal-squad.md: Added platform table, replaced all hardcoded paths - installation.md: Clarified platform-specific paths in setup instructions - cli.md, config.md, sdk.md: Updated resolution order documentation - api-reference.md: Expanded path examples for all platforms - consult.ts: Updated JSDoc comments to reference the resolver function Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
Closing — branch was created from dev. Will re-do from main. |
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
1 participant
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.
Closes #343
Replaces hardcoded
~/.squad/references in docs and code comments with platform-aware descriptions.Problem
The SDK correctly resolves personal squad paths via
resolveGlobalSquadPath()(Linux:~/.config/squad/, macOS:~/Library/Application Support/squad/, Windows:%APPDATA%\squad\), but docs were using~/.squad/which doesn't match any platform.Solution
Documentation changes:
personal-squad.md: Added platform comparison table, replaced all hardcoded~/.squad/referencesinstallation.md: Clarified platform-specific paths in setup and troubleshootingcli.md,config.md,sdk.md: Updated resolution order to show actual platform pathsapi-reference.md: ExpandedresolveGlobalSquadPath()examples for all platformsCode changes:
consult.ts: Updated JSDoc comments to reference the resolver function instead of hardcoded pathsFiles changed
All references now correctly describe the platform-specific behavior.
Working as PAO (DevRel)