Skip to content

docs: improve installation instructions with workflow details and heartbeat config#467

Merged
bradygaster merged 1 commit intobradygaster:devfrom
tamirdresher:contrib/docs-improve-installation-456
Mar 20, 2026
Merged

docs: improve installation instructions with workflow details and heartbeat config#467
bradygaster merged 1 commit intobradygaster:devfrom
tamirdresher:contrib/docs-improve-installation-456

Conversation

@tamirdresher
Copy link
Copy Markdown
Collaborator

Summary

Addresses #456 — installation instructions were missing key steps around workflow files, heartbeat configuration, and integrating Squad into existing projects.

Changes

\docs/src/content/docs/get-started/installation.md\

  • Expanded \squad init\ output to show workflows and templates created
  • Added workflow table listing the 5 GitHub workflows created during init
  • Added commit reminder — workflows are staged but not committed during Copilot sessions
  • Added heartbeat schedule section with instructions to uncomment cron and common schedule examples (30 min, hourly, business hours, daily)
  • Added 'existing project' section with example prompt showing how to give Squad context about an existing codebase
  • Linked to existing-repo.md for the full walkthrough

\docs/src/content/docs/get-started/five-minute-start.md\

  • Updated init output to mention workflow files
  • Added commit/push step so workflows are deployed to the default branch

Why This Matters

New users running \squad init\ didn't know:

  1. Workflow files need a separate commit to work
  2. The heartbeat cron is disabled by default and how to enable it
  3. How to add Squad to an existing project (not just greenfield)

@bradygaster bradygaster changed the base branch from main to dev March 20, 2026 03:54
@bradygaster bradygaster reopened this Mar 20, 2026
@bradygaster bradygaster reopened this Mar 20, 2026
@bradygaster bradygaster changed the base branch from dev to main March 20, 2026 04:21
@bradygaster bradygaster changed the base branch from main to dev March 20, 2026 04:21
…rtbeat config (bradygaster#456)

- Document the GitHub workflows created by squad init
- Add instructions for committing generated workflow files
- Add heartbeat cron schedule configuration with common examples
- Add guidance for integrating Squad into an existing project
- Update five-minute-start.md to mention workflows and commit step

Fixes bradygaster#456

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@bradygaster bradygaster force-pushed the contrib/docs-improve-installation-456 branch from b0b4b06 to 2be8434 Compare March 20, 2026 08:22
@bradygaster bradygaster merged commit abab91e into bradygaster:dev Mar 20, 2026
2 checks passed
chrislomonico pushed a commit to clomonico/squad that referenced this pull request Mar 26, 2026
…er#449, bradygaster#452) (bradygaster#467)

- System messages: change prefix from '▸ system:' to '[system]' bracket convention
- Welcome hint: prefer lead/coordinator/architect agent over first agent

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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.

2 participants