Skip to content

docs: Add building extensions guide#438

Closed
diberry wants to merge 6 commits intobradygaster:devfrom
diberry:squad/building-extensions-guide
Closed

docs: Add building extensions guide#438
diberry wants to merge 6 commits intobradygaster:devfrom
diberry:squad/building-extensions-guide

Conversation

@diberry
Copy link
Copy Markdown
Collaborator

@diberry diberry commented Mar 16, 2026

Practical guide for authoring Squad extensions (skills, ceremonies, directives).

Fills the gap between the extensibility decision tree and plugin installation docs.

Changes

  • New doc: \docs/src/content/docs/guide/building-extensions.md\
  • Updated test assertions: \ est/docs-build.test.ts\

Notes

Follows Microsoft style guide, keeps content concise (82 lines), and links to related docs.

Copilot AI added 6 commits March 16, 2026 10:38
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Adds comprehensive extensibility guide at docs/guide/extensibility.md to help Squad users determine WHERE their change idea belongs (Core, Extension, or Team Config).

Key sections:
- Three-layer extensibility model
- Decision tree flowchart (text-based)
- Examples for each layer
- The Claire test (RFC bradygaster#328 as worked example)
- When to escalate to core
- How to build a plugin

Addresses common confusion about what belongs in Squad core vs plugins vs team configuration.

Updates test assertions in docs-build.test.ts for new guide page.

Related: bradygaster#328

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Captures the architectural decision behind the extensibility guide: Squad core stays small, most ideas are composition (skills/ceremonies/directives).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Flight's review flagged 559 lines as too verbose. Compressed to 100 lines:
- Kept: three-layer decision tree, Claire's RFC example, escalation signals
- Cut: verbose explanations, extended examples, repetitive how-to sections

Target Brady's preference: small, strategic docs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Practical guide for authoring Squad extensions (skills, ceremonies, directives).
Fills the gap between the extensibility decision tree and plugin installation docs.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
andikrueger pushed a commit to andikrueger/squad that referenced this pull request Mar 16, 2026
…r#438)

* chore(squad): quality review findings — 7 issues filed

Quality audit complete: 5 agents assessed CLI across testing, coverage, stability, accessibility, UX.
Results: 4 P0 blockers (bradygaster#365bradygaster#368), 3 P1 items (bradygaster#369bradygaster#371).
Blocking: Waingro dead sessions, ErrorBoundary, dropped input; Marquez help text consistency.

Changes:
- Logged session summary to .squad/log/2026-02-24T0205-quality-review-complete.md
- Updated .squad/identity/now.md with quality review findings and new issue numbers

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* chore(squad): merge decision — Marquez UX audit findings

Quality assessment merged from inbox (Grade B): 11 improvements (3 P0, 4 P1, 4 P2). help text, stub commands, vocabulary, separators, roster.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix bradygaster#419/bradygaster#424: Restructure /help for scannability

Show 3-5 most essential commands by default, with clear pointer to /help full for complete reference.

Default /help now fits in ~5 lines:
- Commands: /status, /history, /agents, /quit
- Type /help full for complete docs

/help full shows the complete list with descriptions, matching previous behavior.

Closes bradygaster#419, bradygaster#424

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

* Fix bradygaster#421: Lead with default behavior in --help

The CLI help now leads with 'Just type — squad routes your message to the right agent automatically' before listing commands. This makes it clear that the primary way to use squad is to run it with no args and talk naturally.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry
Copy link
Copy Markdown
Collaborator Author

diberry commented Mar 16, 2026

✅ APPROVE

This guide fills the critical gap between extensibility and plugins docs.

Strengths:

  • Correct extension structure (skills/, ceremonies/, directives/)
  • Practical 5-step build flow (repo → skill → ceremony → README → local test)
  • 126 lines, sentence-case headings, active voice — meets Brady's small & strategic preference
  • Properly integrated into docs-build tests
  • Clear cross-references; no duplication with extensibility.md or plugins.md

Ready to merge.

@diberry
Copy link
Copy Markdown
Collaborator Author

diberry commented Mar 16, 2026

Consolidated into PR #436 — both the extensibility decision tree and building extensions guide are now in one PR.

@diberry diberry closed this Mar 16, 2026
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