Skip to content

fix(docs): replace ~/.squad/ with platform-specific path references#346

Merged
bradygaster merged 1 commit intobradygaster:mainfrom
jsturtevant:squad/343-fix-personal-squad-path-docs-v2
Mar 13, 2026
Merged

fix(docs): replace ~/.squad/ with platform-specific path references#346
bradygaster merged 1 commit intobradygaster:mainfrom
jsturtevant:squad/343-fix-personal-squad-path-docs-v2

Conversation

@jsturtevant
Copy link
Copy Markdown
Contributor

Closes #343

Replaces hardcoded ~/.squad/ references in docs 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\

But docs were using ~/.squad/ which doesn't match any platform.

Changes

  • Docs: Updated all references to show platform-specific paths (tables) or generic "personal squad directory" text
  • Code comments: Updated to reference resolveGlobalSquadPath() instead of hardcoded paths

Files changed

  • docs/src/content/docs/get-started/installation.md
  • docs/src/content/docs/guide/personal-squad.md
  • docs/src/content/docs/reference/api-reference.md
  • docs/src/content/docs/reference/cli.md
  • docs/src/content/docs/reference/config.md
  • docs/src/content/docs/reference/sdk.md
  • packages/squad-sdk/src/sharing/consult.ts

Note: This is a redo of #345, branching from main instead of dev as requested.

Closes bradygaster#343

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
bradygaster added a commit that referenced this pull request Mar 13, 2026
…346)

Replaces hardcoded ~/.squad/ references with platform-aware descriptions. The SDK correctly resolves personal squad paths via resolveGlobalSquadPath().

Co-authored-by: James Sturtevant <648372+jsturtevant@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bradygaster bradygaster merged commit 58544b8 into bradygaster:main Mar 13, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Personal squad docs reference ~/.squad/ instead of platform-specific paths

2 participants