Skip to content

docs: document squad config model CLI command#73

Closed
diberry wants to merge 1 commit intodevfrom
squad/68-config-model-docs
Closed

docs: document squad config model CLI command#73
diberry wants to merge 1 commit intodevfrom
squad/68-config-model-docs

Conversation

@diberry
Copy link
Copy Markdown
Owner

@diberry diberry commented Mar 27, 2026

Closes #68

Documents the \squad config model\ CLI command for model pinning.

Source: bradygaster#628 by Brady Gaster

Changes

  • New docs page for \squad config model\ command at
    eference/config-model.md\
  • Navigation entry added in Reference section
  • Test assertions updated in \docs-build.test.ts\
  • CLI reference table updated with config model entries
  • PAO history updated

⚠️ Awaiting Flight + FIDO review before merge.

@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 27, 2026

🏗️ Flight — Lead Review

PR: docs: document squad config model CLI command — Closes #68
Source: bradygaster#628 — ported by PAO


What I reviewed

  • docs/src/content/docs/reference/config-model.md — new reference page (188 lines)
  • docs/src/content/docs/reference/cli.md — count bump + 4 new table rows
  • docs/src/navigation.ts — nav entry in Reference section
  • test/docs-build.test.ts — EXPECTED_REFERENCE updated
  • .squad/agents/pao/history.md — session learnings logged

✅ What's good

Content quality is high. The new config-model.md page covers everything a user needs:

  • Clear "What it does" framing upfront
  • Syntax block with all flag permutations
  • Arguments and Options tables — properly separated
  • Five working examples with expected terminal output
  • The model resolution hierarchy table (Layer 1–5) is excellent context — critical for users to understand what config model actually controls
  • Config file format documented with field-level types and semantics
  • Available models catalog grouped by tier
  • Validation behavior described (both model name and agent name validation)
  • "See also" cross-links to feature docs, scenario guide, and config reference

Count math is correct. 16 → 20: exactly four new rows added (config model, config model <name>, config model <name> --agent <a>, config model --clear). ✓

Navigation placement is right. Config Model inserted after Config in Reference — logical grouping, alphabetically coherent.

Test update is consistent. config-model inserted between config and api-reference in EXPECTED_REFERENCE — mirrors navigation order. ✓

Experimental warning at top of page is appropriate for alpha-stage software. ✓

PAO history entry is well-written — captures the TDD approach, the cross-linking decision rationale, and the Windows EBUSY environment note. Good institutional memory.


🔍 Minor observations (non-blocking)

  1. CLI table ordering: config model rows are inserted between copilot --agent squad and squad nap. Slightly discontinuous — config model feels like it belongs earlier near other config-adjacent commands — but this is cosmetic and doesn't affect usability.

  2. Internal link format: cli.md links to /docs/reference/config-model/. Verify this resolves correctly against the Astro base path config. If the site root is /docs/, the link is correct; if it's /, the leading /docs prefix would 404. Worth a quick spot-check in the deployed preview if one exists.

  3. Double blank line after the experimental callout in config-model.md is unusual — single blank line is the house style. Very minor.


Summary

This is a clean, thorough documentation PR. Structure follows existing reference page conventions, examples are practical, and the model resolution context table is the right level of depth for a reference page. No accuracy concerns, no missing pieces.

Verdict: APPROVE

@diberry diberry force-pushed the squad/68-config-model-docs branch from cc93e17 to 2fc0393 Compare March 27, 2026 18:33
@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 27, 2026

🧪 FIDO — Quality Review

PR: #73docs: document squad config model CLI command
Branch: squad/68-config-model-docs
Reviewer: FIDO (Quality Owner)


Checklist

Check Result Notes
Test assertions updated in docs-build.test.ts ✅ Pass EXPECTED_REFERENCE correctly adds 'config-model'
Nav slug matches file path ✅ Pass reference/config-modeldocs/src/content/docs/reference/config-model.md
Internal links valid ✅ Pass All 4 cross-linked files confirmed to exist
npm run build --prefix docs ✅ Pass Build completed with zero errors
docs-build.test.ts — all 22 tests ✅ Pass All 22 tests pass after build

Detail

Test run: All 22 tests passed. A [vitest-worker]: Timeout calling "onTaskUpdate" unhandled error appeared — this is the known Windows EBUSY / esbuild file-lock issue documented in the PAO history, not a test failure. Build-triggered tests are reliable; the vitest worker timeout is a local environment artifact.

CLI count: cli.md updated from 16 → 20 commands (+4 config model variants). Count is correct.

Content quality: The new reference page is well-structured — clear syntax table, arguments/options breakdown, examples with expected output, config file schema, model resolution layer table, and a "See also" section. Cross-links to model-selection/#5-layer-model-resolution are accurate.

No issues found.


Verdict: APPROVE

@diberry diberry force-pushed the squad/68-config-model-docs branch from 2fc0393 to 9b5b00c Compare March 27, 2026 18:42
@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 27, 2026

🧪 FIDO — Re-Review

PR: #73docs: document squad config model CLI command
Branch: squad/68-config-model-docs
Reviewer: FIDO (Quality Owner)
Trigger: Re-review requested after PAO fixes


Checklist

Check Result Notes
npm run build --prefix docs ✅ Pass Zero errors
docs-build.test.ts — all 22 tests ✅ Pass 22/22 passed
No .squad/ files in diff ✅ Pass 4 files, all under docs/ and test/
Link format (no /docs/ prefix) FAIL 7 broken links in config-model.md

❌ Blocker: /docs/ prefix in links — config-model.md

The house convention (confirmed from sdk.md, cli.md, and all existing reference pages) is to use no /docs/ prefix on internal links. Example of correct format: [model preferences](/reference/config-model/) (as used in the cli.md change in this same PR).

config-model.md has 7 links that violate this:

Location Current (broken) Correct
"What it does" section /docs/features/model-selection/#5-layer-model-resolution /features/model-selection/#5-layer-model-resolution
"Clear the default model" example /docs/features/model-selection/#5-layer-model-resolution /features/model-selection/#5-layer-model-resolution
"How it fits" section /docs/features/model-selection/#5-layer-model-resolution /features/model-selection/#5-layer-model-resolution
See also — Model selection /docs/features/model-selection/ /features/model-selection/
See also — Switching models /docs/scenarios/switching-models/ /scenarios/switching-models/
See also — Configuration reference /docs/reference/config/#model-configuration /reference/config/#model-configuration
See also — CLI reference /docs/reference/cli/ /reference/cli/

These will 404 in production if the Astro base is /docs/, because the router would resolve them as /docs/docs/....


✅ Everything else looks good

  • Build: clean, no errors
  • Tests: 22/22 passing
  • No .squad/ files in diff — clean boundary
  • CLI count math correct (16 → 20, four new rows)
  • Nav placement and test assertion consistent
  • cli.md new link uses correct format: /reference/config-model/

Verdict: NEEDS FIXES

Strip /docs/ from the 7 links in config-model.md listed above, then re-request review.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@diberry diberry force-pushed the squad/68-config-model-docs branch from 9b5b00c to 9f57795 Compare March 27, 2026 18:47
@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 27, 2026

Flight - Re-Review

Checked the diff after PAO fixes. Here is the status on each of the 3 items:


1. CLI table placement - NOT FIXED

The config model rows were moved to after squad plugin marketplace and before squad export. But the requirement was to place them near other config commands - and there are no other squad config commands in the table. The rows cannot satisfy that criterion.

The rows are still broadly between the copilot block (rows ~13-15) and the nap block (rows ~29-31) in the table. Moving them one slot down (inserting plugin marketplace in front) does not resolve the grouping problem.

Suggested fix: Move the four config model rows to sit directly after squad upgrade --migrate-directory and squad link - those are the other configure-Squad commands near the top of the table. Alternatively, move them to just before squad nap as a terminal configuration/maintenance group.


2. Link format - FIXED

The CLI table now uses /reference/config-model/ (no /docs/ prefix). Correct.


3. Double blank line in config-model.md - FIXED

No consecutive blank lines found in the current diff.


Verdict: NEEDS FIXES

Two of three issues resolved. The CLI table placement still needs a proper fix - the config model rows must be near configuration-related commands (upgrade, link), not floating between the plugin and export rows.

@diberry
Copy link
Copy Markdown
Owner Author

diberry commented Mar 27, 2026

Closing: upstream PR now exists on bradygaster/squad. Work continues there.

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