Skip to content

docs: the install instructions pinned v1.2.1 on a 2.0.0b4 package - #125

Merged
sagi5060 merged 1 commit into
devfrom
fix/docs-install-pin
Aug 6, 2026
Merged

docs: the install instructions pinned v1.2.1 on a 2.0.0b4 package#125
sagi5060 merged 1 commit into
devfrom
fix/docs-install-pin

Conversation

@sagi5060

@sagi5060 sagi5060 commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Found by the #71 audit. docs-site/content/getting-started.mdx — the canonical getting-started page — told every new user to uv pip install …@v1.2.1, on a package that is at 2.0.0b4. So the documented path installed v1.

Nothing gates it, which is why it rotted: test_docs_site.py only parses python fences, and docs-check.yml only asserts the build produced out/index.html. docs/delivery/docs-site-plan.md predicted exactly this and asked for a release-checklist item that was never added — so the release skill's preflight now greps docs-site/content/ for a pinned version.

Also drops ssh://git@ for https: the repository is public, so the credentials the old instructions implied were never needed.

Docs and a skill file only — no package change, no test change.

Judgment ledger

  • A grep in the release preflight, not a test. A test that asserted the pin matches pyproject.toml would fail on dev for the whole window between a release and the next docs edit, and pinning "latest" in the docs is not what we want either — the install line should name a released tag. A preflight step puts the check where the version actually changes.
  • Left every other v1.2.1 reference alone. The remaining ones (docs/agentdeck-prd.md, docs/project-brief.md, docs/delivery/docs-site-plan.md) are historical or normative statements about the frozen baseline — "v1.2.1 projects load unchanged" is a requirement, not a stale pin.

The canonical getting-started page told every new user to install v1, and
nothing gates it: test_docs_site.py only parses python fences and
docs-check.yml only asserts the build produced a page. The release skill now
greps docs-site for a pinned version at preflight. Also drops the ssh URL —
the repository is public, so credentials were never needed.
@sagi5060
sagi5060 merged commit 957718f into dev Aug 6, 2026
2 checks passed
@sagi5060
sagi5060 deleted the fix/docs-install-pin branch August 6, 2026 10:43
sagi5060 added a commit that referenced this pull request Aug 6, 2026
Three real conflicts, all resolved as a union rather than by taking a side:

- Runtime._bind: #116 binds a Reporter and its per-run report buffer; this slice
  binds the Gate with the poll interval #85 added. Both now happen in the one
  binder, and _with_gate — which the auto-merge replaced with #116's _bind — is
  gone, with its two remaining call sites (resume, resume_run) moved over.
- Runtime._play: this slice folded run/resume's two inlined bodies into one; #116
  had added its report drain to both copies. The drain now lives once in _play, so
  all three openings (start, resumed interrupt, lifted pause) drain identically —
  and resume_run gets #116's reporting for free rather than silently missing it.
- CHANGELOG: both sides added an Added entry. Both kept. Also removed a duplicated
  ### Removed block (#118's entries appeared twice) left by an earlier merge.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.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.

1 participant