Skip to content

Bring the docs and the changelog up to date with the code before release - #711

Merged
davidmckayv merged 2 commits into
mainfrom
david/docs-release-audit
Oct 2, 2026
Merged

davidmckayv merged 2 commits into
mainfrom
david/docs-release-audit

Conversation

@davidmckayv

Copy link
Copy Markdown
Contributor

Docs and changelog pass before the next release. Every changed claim was checked line by line against the code on main, with a file and line behind it.

README

  • New Intelligence on your own machine section linking Evaluate Intelligence locally. The free Developer plan qualifies; the 30-day local licence renews with local renew.
  • The CLI writes CPK_INTELLIGENCE_API_KEY, but the server reads only INTELLIGENCE_API_KEY (server/src/config.ts:889). The section says to copy the value across.
  • The build-it-with-you callout now offers the local stack as the way to start in the meantime.
  • Routes table, architecture table (the routine worker), catalogue (Parallel Search), start.sh/stop.sh behaviour and INITIAL_ADMIN_EMAILS brought up to date.

Docs

  • configuration.md: Automatic Learning variables, SERVER_PORT, PICKED_HARNESS_*, remote-mastra, current tenant package rules (duplicate refusals, the 2 to 40 character skill slug), model.yaml accepting anthropic, a broken chart link.
  • architecture.md: headless computer use, egress modes, group conversations, coworker handoff, what start.sh starts.
  • coworkers.md, routines.md, releasing.md, windows-signing.md, composio.md, development.md, chart README, .env.example: stale statements corrected.

CHANGELOG (Unreleased)

  • A Before upgrading note: Learning on by default, computers refuse the network until their policy arrives, migrations 0042 to 0051, Windows LF re-checkout.
  • Added missing entries: Automatic Learning, Parallel Search, constant-time token checks, the lodash-es pin.
  • Moved seven entries that had been written into the released 0.0.15 and 0.0.14 sections after their tags. Those sections now match v0.0.15 exactly.
  • Overclaims fixed: the provider spec file is not read by the Claude Agent SDK Bot; the unreleased desktop microphone sentence is dropped.

Found, not fixed here (code)

  • A remote Bot cannot hand work on: grants to a remote grantee are accepted, but botsReachableFrom keeps only built-in Bots.
  • The settings feat: Bots work as coworkers #673 added (OpenTag, Twilio, SCIM, OTel, inbound email, Expo) have no chart values; they need config.extraEnv.
  • Stale messages: server/src/config.ts:742, server/src/plugins/catalogue.ts:152, server/src/agents/profile-store.ts:63.

Every claim in the README, .env.example, docs/ and the chart README was
checked against the code on main and corrected where it had drifted.
The README points to running Intelligence locally on the free Developer
plan and to having CopilotKit build OpenBot with you.

The Unreleased changelog gains entries for Automatic Learning, Parallel
Search, constant-time token checks and the lodash-es pin, an upgrade note
naming migrations 0042 to 0051, and the entries that had been written into
the already released 0.0.15 and 0.0.14 sections after their tags.
…hart replaced

architecture doc no longer describes every such hop as refused. #717
gives the delivery, SCIM, inbound email and OTel settings their own chart
values, which supersedes the extraEnv guidance.
@davidmckayv
davidmckayv force-pushed the david/docs-release-audit branch from 2385bd9 to eac7920 Compare October 2, 2026 20:23
@davidmckayv
davidmckayv merged commit d374235 into main Oct 2, 2026
21 checks passed
@davidmckayv
davidmckayv deleted the david/docs-release-audit branch October 2, 2026 20:35
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