Skip to content

docs: align pilot workflow with Assay 1.22#44

Open
Haserjian wants to merge 1 commit into
mainfrom
docs/coherence-2026-04-22
Open

docs: align pilot workflow with Assay 1.22#44
Haserjian wants to merge 1 commit into
mainfrom
docs/coherence-2026-04-22

Conversation

@Haserjian
Copy link
Copy Markdown
Owner

@Haserjian Haserjian commented Apr 22, 2026

Summary

Unify the pip install assay-ai clauses in docs/pilot/quickstart.md and docs/pilot/starter-workflow.yml to the same pin, assay-ai==1.22.0. Scope is intentionally limited to these two files — the two surfaces a pilot team copy-pastes into their own repo.

File:line Before After
docs/pilot/quickstart.md:67 "assay-ai @ git+https://github.com/Haserjian/assay.git@13db5ba" "assay-ai==1.22.0"
docs/pilot/quickstart.md:86 "assay-ai>=1.10.1" "assay-ai==1.22.0"
docs/pilot/starter-workflow.yml:53 "assay-ai @ git+https://github.com/Haserjian/assay.git@13db5ba" "assay-ai==1.22.0"
docs/pilot/starter-workflow.yml:82 "assay-ai>=1.10.1" "assay-ai==1.22.0"

Motivation

A pilot team copying docs/pilot/starter-workflow.yml today gets one job installing an old git-commit pin and another installing >=1.10.1, neither of which is the released 1.22.0. docs/pilot/outreach.md:68-69 points readers at both files, so the stale pins actively propagate through every pilot invitation. Quickstart had been partially fixed earlier; starter-workflow was the remaining gap.

Scope notes

  • docs/pilot/failure-modes.md:64 still shows "assay-ai==1.10.1" inside a troubleshooting example block (### "pip install assay-ai failed"). That's an illustrative example of "pin a version if PyPI is flaky" rather than the pilot's actual install instruction, so it's intentionally out of scope for this PR. A follow-up can bump that example for consistency if wanted.
  • The outreach email (docs/pilot/outreach.md) doesn't mention specific versions and doesn't need to change — its links now resolve to coherent files.

Related

Companion branch ops/public-coherence-pass-2026-04-09 touched adjacent surfaces earlier. This PR is the focused quickstart + starter-workflow slice; reviewer can decide whether to land this first or roll into that branch.

Test plan

  • grep -n "assay-ai" docs/pilot/quickstart.md docs/pilot/starter-workflow.yml returns only assay-ai==1.22.0
  • Outreach links (docs/pilot/outreach.md:68-69) still resolve
  • Starter workflow copied into a test repo installs 1.22.0 in both jobs

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings April 22, 2026 21:41
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the pilot documentation workflow snippets to consistently install the released assay-ai==1.22.0, avoiding stale git-commit pins or loose minimum-version constraints in the “proof-carrying PR” quickstart and starter workflow.

Changes:

  • Replace assay-ai @ git+https://...@13db5ba with assay-ai==1.22.0 in the pilot starter workflow.
  • Replace assay-ai>=1.10.1 with assay-ai==1.22.0 in the pilot starter workflow.
  • Align the same two install locations in the quickstart snippet to assay-ai==1.22.0.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
docs/pilot/starter-workflow.yml Pins both “Install assay” steps to assay-ai==1.22.0 for consistent CI behavior.
docs/pilot/quickstart.md Pins both pip install lines in the example workflow to assay-ai==1.22.0 to match the intended pilot setup.

Comment thread docs/pilot/quickstart.md
with:
python-version: "3.12"
- run: pip install "assay-ai @ git+https://github.com/Haserjian/assay.git@13db5ba"
- run: pip install "assay-ai==1.22.0"
Copy link

Copilot AI Apr 22, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PR description/test plan suggest the pilot docs are now fully unified on assay-ai==1.22.0, but docs/pilot/failure-modes.md still includes an example pin (pip install "assay-ai==1.10.1"). Consider updating that snippet to 1.22.0 as well, or clarifying in the PR description/test plan that only quickstart + starter-workflow are in scope.

Copilot uses AI. Check for mistakes.
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